Skip to content

Commit ab75c84

Browse files
committed
Merge pull request #93 from geeknam/develop
Added instructions for contributors
2 parents 369898a + 0449a40 commit ab75c84

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

CONTRIBUTING.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Contributing to python-gcm
2+
===
3+
We'd love to accept your patches!
4+
To contribute to python-gcm simply open a pull request against the [develop branch](https://github.com/geeknam/python-gcm/tree/develop)
5+
6+
Some things that will increase the chance that your pull request is accepted:
7+
* Succinctly describe your changes in the pull request description
8+
* Write tests:
9+
* new features should include tests
10+
* changes to existing code should be reflected in the tests
11+
* code coverage should not decrease
12+
* run **all** the tests to assure nothing else was accidentally broken.
13+
* Be consistent with the coding style
14+
* Make commits of logical units
15+
* Write descriptive commit messages
16+
* Check for unnecessary whitespace with `git diff --check` before committing.

README.rst

+8
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,11 @@ Read more on response errors `here
134134
* GCMMessageTooBigException
135135
* GCMInvalidRegistrationException
136136
* GCMUnavailableException
137+
138+
Contributing
139+
==========
140+
See `CONTRIBUTING.md <CONTRIBUTING.md>`_
141+
142+
Licensing
143+
=======
144+
See `LICENSE <LICENSE>`_

0 commit comments

Comments
 (0)