-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fb0cd7e
commit f7d148c
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Contributing | ||
Before starting your work on this module, you should [fork the project] to your GitHub account. This allows you to | ||
freely experiment with your changes. When your changes are complete, submit a [pull request]. All pull requests will be | ||
reviewed and merged if they suit some general guidelines: | ||
|
||
* Changes are located in a topic branch | ||
* For new functionality, proper tests are written | ||
* Changes should not solve certain problems on special environments | ||
|
||
## Branches | ||
Choosing a proper name for a branch helps us identify its purpose and possibly find an associated bug or feature. | ||
Generally a branch name should include a topic such as `fix` or `feature` followed by a description and an issue number | ||
if applicable. Branches should have only changes relevant to a specific issue. | ||
|
||
``` | ||
git checkout -b fix/service-template-typo-1234 | ||
git checkout -b feature/config-handling-1235 | ||
git checkout -b doc/fix-typo-1236 | ||
``` | ||
|
||
## Testing | ||
Python modules are unit tested with the Python Standard Library. When modifying existing modules or tasks, make sure all existing tests pass. If you add new functionality, make sure to write appropriate tests as well. | ||
|
||
[fork the project]: https://help.github.com/articles/fork-a-repo/ | ||
[pull request]: https://help.github.com/articles/using-pull-requests/ |