Skip to content

Commit Message Guidelines #963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcharper merged 3 commits into from
Apr 4, 2017
Merged

Commit Message Guidelines #963

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5752a0c
Add commit message guideline statement
meatballs Apr 3, 2017
b3819bc
Correct typo
meatballs Apr 3, 2017
181e92b
Simplify commit guidance wording
meatballs Apr 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/tutorials/contributing/guidelines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,15 @@ The project follows the following guidelines:
2. Try as best as possible to follow `PEP8
<https://www.python.org/dev/peps/pep-0008/>`_ which includes **using
descriptive variable names**.
3. Testing: the project uses the `unittest
3. Commits: Please try to use commit messages that give a meaningful history
for anyone using git's log features. Try to use messages that complete sentence,
"This commit will..." There is some excellent guidance on the subject
from `Chris Beams <https://chris.beams.io/posts/git-commit/>`_
4. Testing: the project uses the `unittest
<https://docs.python.org/2/library/unittest.html>`_ library and has a nice
testing suite that makes some things very easy to write tests for. Please try
to increase the test coverage on pull requests.
4. Merging pull-requests: We require two of the (currently four) core-team
5. Merging pull-requests: We require two of the (currently three) core-team
maintainers to merge. Opening a PR for early
feedback or to check test coverage is OK, just indicate that the PR is not ready
to merge (and update when it is).
Expand Down