Skip to content

Commit

Permalink
CONTRIBUTING.md: Put Submitting section first
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Waugh <twaugh@redhat.com>
  • Loading branch information
twaugh committed Jan 13, 2017
1 parent d34ccff commit b14ce78
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
Contribution Guide
==================

Submitting changes
------------------

Changes are accepted through pull requests.

Please create your feature branch from the *master* branch. Make sure to add unit tests under the `tests/` subdirectory (we use py.test and flexmock for this). When you push new commits, tests will be triggered to be run in [Travis CI](https://travis-ci.org/) and results will be shown in your pull request. You can also run them locally from the top directory (`py.test tests`).

Follow the PEP8 coding style. This project allows 99 characters per line.

Please make sure each commit is for a complete logical change, and has a [useful commit message](http://chris.beams.io/posts/git-commit/). When making changes in response to suggestions, it is fine to make new commits for them but please make sure to squash them into the relevant "logical change" commit before the pull request is merged.

Before a pull request is approved it must meet these criteria:
- unit tests pass
- code coverage from testing does not decrease and new code is covered

Once it is approved by two developer team members it may be merged. To avoid creating merge commits the pull request will be rebased during the merge.

Licensing
---------

Expand Down Expand Up @@ -35,20 +52,3 @@ By making a contribution to this project, I certify that:
```

You can do this by using `git commit --signoff` when committing changes, making sure that your real name is included.

Submitting changes
------------------

Changes are accepted through pull requests.

Please create your feature branch from the *master* branch. Make sure to add unit tests under the `tests/` subdirectory (we use py.test and flexmock for this). When you push new commits, tests will be triggered to be run in [Travis CI](https://travis-ci.org/) and results will be shown in your pull request. You can also run them locally from the top directory (`py.test tests`).

Follow the PEP8 coding style. This project allows 99 characters per line.

Please make sure each commit is for a complete logical change, and has a [useful commit message](http://chris.beams.io/posts/git-commit/). When making changes in response to suggestions, it is fine to make new commits for them but please make sure to squash them into the relevant "logical change" commit before the pull request is merged.

Before a pull request is approved it must meet these criteria:
- unit tests pass
- code coverage from testing does not decrease and new code is covered

Once it is approved by two developer team members it may be merged. To avoid creating merge commits the pull request will be rebased during the merge.

0 comments on commit b14ce78

Please sign in to comment.