diff options
| author |  Melissa Xie <melissa@thoughtbot.com> | 2014-11-24 14:27:01 -0500 |
|---|---|---|
| committer | Melissa Xie <melissa@thoughtbot.com> | 2014-11-24 14:27:01 -0500 |
| commit | 21726c6e9eeb2f422749580528b41fb6d0b0b422 (patch) | |
| tree | f555b6aef24bab6f28026e63664e985b588badae /CONTRIBUTING.md | |
| parent | 3433f9e2883e6a7f43e21ac0cfd233b2c74ee938 (diff) | |
Expand on instructions for contributors to get started
These changes:
* add the steps needed to get set up
* update the docs regarding mandatory tests
* clarify release instructions
* fix documentation formatting
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d447b3..7b00399 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,8 +4,14 @@ Contributing Overview -------- +- Fork the repo. +- Prepare the build system: `./autogen.sh`. (This depends on GNU autoconf and + GNU automake.) +- Configure the package: `./configure`. +- Make sure the tests pass: `make check`. +- Make your changes. - Update `NEWS.md.in`. -- Update `.mailmap`. +- Update `.mailmap` if necessary. - Write a test covering your feature or fix. - Ensure existing and new tests are passing. - Submit a pull request on GitHub. @@ -22,11 +28,9 @@ We use your name and email address as produced by `git-shortlog(1)`. You can change how this is formatted by modifying `.mailmap`. More details on that file can be found in the git [Documentation/mailmap.txt][mailmap]. -Our test suite is new, and therefore it is not yet mandatory to include -tests with pull requests. However, you must ensure that the existing -test suite passes with any changes you make. Also, any attempts to add -or extend tests will increase the chances of your pull request being -merged. +It is mandatory to include tests with pull requests. You must ensure that the +existing test suite passes with any changes you make. Also, any attempts to add +or extend tests will increase the chances of your pull request being merged. Submit a pull request using GitHub. If there is a relevant bug, mention it in the commit message (`Fixes #42.`). @@ -34,10 +38,10 @@ it in the commit message (`Fixes #42.`). [mailmap]: https://github.com/git/git/blob/master/Documentation/mailmap.txt Testing ------ +------- -The test suite uses [cram][]. It is an integration suite, meaning the -programs are exercised from the outside and assertions are made only on +The test suite uses [cram][]. It is an integration suite, meaning the +programs are exercised from the outside and assertions are made only on their output or effects. All tests can be run like so: |