Skip to content

Commit

Permalink
fixup! github: Fill in more contributing doc. Add issue/PR templates.
Browse files Browse the repository at this point in the history
Fix syntax errors
  • Loading branch information
chfoo committed Jun 3, 2016
1 parent da091a0 commit a317ea0
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 15 deletions.
16 changes: 6 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Thank you for your interest in contributing!


Issues
++++++
------

Hopefully you are arriving from
[the documentation](https://wpull.readthedocs.io/). If not, please take
Expand Down Expand Up @@ -34,14 +34,13 @@ When you file an issue, a template should appear for you to fill out.


Pull requests
+++++++++++++
-------------

If you are planning to fix a bug or add a feature, please take some
time to review this section.


Code convention
---------------
### Code convention

Please follow the [PEP8](https://www.python.org/dev/peps/pep-0008/)
conventions whenever possible.
Expand All @@ -53,8 +52,7 @@ bug fixes or features. This will help make Git's blame feature easier
use.


Commits and commit messages
---------------------------
### Commits and commit messages

Please don't PR a single huge commit or hundreds of commits. Do your
best to group changes logically.
Expand All @@ -64,8 +62,7 @@ a short title describing the changes and then add an optional paragraph
describing why you made those changes.


Branch model
------------
### Branch model

This project is still small but we intend to follow
[nvie's git branching model]
Expand Down Expand Up @@ -94,8 +91,7 @@ feature to avoid any rejection and disappointment.
One branch per bug/feature. Don't stack PR on top of other PR branches!


Making the PR
+++++++++++++
### Making the PR

When you file a pull request, a template will appear reminding you
of this document. It will also remind you to:
Expand Down
10 changes: 5 additions & 5 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This pull request fixes #N (where N is the issue number).

I remembered to:

[ ] Update or add unit tests if needed
[ ] Update or add documentation/comments if needed
[ ] Made sure stray files or whitespace didn't get committed
[ ] If significant changes, branch from `develop` and set to merge into `develop`
[ ] Read the guidelines for contributing
* [ ] Update or add unit tests if needed
* [ ] Update or add documentation/comments if needed
* [ ] Made sure stray files or whitespace didn't get committed
* [ ] If significant changes, branch from `develop` and set to merge into `develop`
* [ ] Read the guidelines for contributing

Changes:

Expand Down

0 comments on commit a317ea0

Please sign in to comment.