From 21726c6e9eeb2f422749580528b41fb6d0b0b422 Mon Sep 17 00:00:00 2001 From: Melissa Xie Date: Mon, 24 Nov 2014 14:27:01 -0500 Subject: 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 --- .mailmap | 1 + CONTRIBUTING.md | 22 +++++++++++++--------- DEVELOPERS.md | 6 ++---- NEWS.md.in | 2 +- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/.mailmap b/.mailmap index 68cc9bb..8e4a87c 100644 --- a/.mailmap +++ b/.mailmap @@ -1,6 +1,7 @@ George Brocklehurst George Brocklehurst Javier López +Melissa Xie Mike Burns Pablo Olmos de Aguilera Corradini Patrick Brisbin 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: diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 5a92da8..8e6f327 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -4,11 +4,9 @@ Developers Making a release ---------------- -1. Bump the version in `configure.ac`, in `AC_INIT`. +1. Bump the version within the `AC_INIT` macro call in `configure.ac`. -2. Update the build system. This depends on GNU autoconf and GNU automake. - - ./autogen.sh +2. Update the build system by running: `./autogen.sh`. 3. Build the packages: diff --git a/NEWS.md.in b/NEWS.md.in index a6272cf..7569d7b 100644 --- a/NEWS.md.in +++ b/NEWS.md.in @@ -2,7 +2,7 @@ rcm (@PACKAGE_VERSION@) unstable; urgency=low * BUGFIX: Use custom function instead of `readlink` to resolve symlinks in test helpers (Melissa Xie). - * Documentation fixes (Melissa Xie) + * Documentation fixes and updates (Melissa Xie). * Show usage information when given bad arguments (Mike Burns). -- Mike Burns Fri, 09 May 2014 14:17:49 +0200 -- cgit v1.2.3