Skip to content

Commit 14333cb

Browse files
committed
reword git section
and other tweaks
1 parent 11bc3c4 commit 14333cb

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

contributing.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,31 @@
11
Some guidelines and tips for development.
22

3-
### git
3+
## git
44

5-
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository.
6-
2. Make changes on a branch of your choice. Atomic commits are better than clobbering commits.
7-
3. [Sync your fork](https://help.github.com/articles/syncing-a-fork/) and keep your branch up to date with [master](https://github.com/X1011/git-directory-deploy/tree/master).
8-
4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/) to this repository.
5+
Feel free to [fork](https://help.github.com/articles/fork-a-repo) this repository and [create a pull request](https://help.github.com/articles/creating-a-pull-request). Before making a large change, please open an issue to discuss it.
96

10-
Once a pull request is opened, be careful with `git commit --amend` and `git rebase`. No need to squash a branch into multiple commits, either. When in doubt, preserve your history.
7+
Make descriptive, granular commits. No need to squash them for the pull request.
118

12-
### syntax & style
9+
If you drift too far from the master branch, please [merge](https://help.github.com/articles/syncing-a-fork) rather than rebasing. This will preserve the commit history that shows the context in which the code was written.
10+
11+
## style
1312

1413
- Tabs for indenting. Spaces for alignment.
15-
- Wrap discrete chunks of code in functions. This makes writing test easier.
14+
- Wrap discrete chunks of code in functions. This makes writing tests easier.
1615
- See [.editorconfig](.editorconfig) for more specifics and exceptions.
1716
- Follow the style you see in the code that's already here.
1817

19-
### testing
18+
## testing
2019

2120
Have [bats](https://github.com/sstephenson/bats#readme) installed.
2221

2322
Groups of tests are in `.bats` files in the repository root. You can [run tests manually](https://github.com/sstephenson/bats#running-tests) or use the `./watch` script (requires [`entr`](https://github.com/clibs/entr)) to automatically run them when any file is changed.
2423

2524
Discrete chunks of code should have a discrete set of tests. If possible, tests should call the relevant function rather than running the whole script.
2625

27-
Write test names so that they tell a story for a test group, and indent each test
26+
Write test names so that they tell a story for a test group, and indent each test.
2827

29-
For anything that involves touching the file system, use `setup()` & `teardown()` functions for the `.bats` file that make the tests run in a temporary folder:
28+
For anything that involves touching the file system, use `setup()` & `teardown()` functions to create a temporary directory:
3029

3130
```bash
3231
setup() {

0 commit comments

Comments
 (0)