1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
Contributing
============
.. sectionauthor:: Matt Swain <m.swain@me.com>
Contributions of any kind are greatly appreciated!
Feedback
--------
The `Issue Tracker`_ is the best place to post any feature ideas, requests and bug reports.
Contributing
------------
If you are able to contribute changes yourself, just fork the `source code`_ on GitHub, make changes and file a pull
request. All contributions are welcome, no matter how big or small.
Quick guide to contributing
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. `Fork the CIRpy repository on GitHub`_, then clone your fork to your local machine::
git clone https://github.com/<username>/CIRpy.git
2. Install the development requirements::
cd cirpy
pip install -r requirements/development.txt
3. Create a new branch for your changes::
git checkout -b <name-for-changes>
4. Make your changes or additions. Ideally add some tests and ensure they pass.
5. Commit your changes and push to your fork on GitHub::
git add .
git commit -m "<description-of-changes>"
git push origin <name-for-changes>
4. `Submit a pull request`_.
Tips
~~~~
- Follow the `PEP8`_ style guide.
- Include docstrings as described in `PEP257`_.
- Try and include tests that cover your changes.
- Try to write `good commit messages`_.
- Consider `squashing your commits`_ with rebase.
- Read the GitHub help page on `Using pull requests`_.
.. _`Issue Tracker`: https://github.com/mcs07/CIRpy/issues
.. _`source code`: https://github.com/mcs07/CIRpy
.. _`Fork the CIRpy repository on GitHub`: https://github.com/mcs07/CIRpy/fork
.. _`Submit a pull request`: https://github.com/mcs07/CIRpy/compare/
.. _`squashing your commits`: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
.. _`PEP8`: https://www.python.org/dev/peps/pep-0008
.. _`PEP257`: https://www.python.org/dev/peps/pep-0257
.. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
.. _`Using pull requests`: https://help.github.com/articles/using-pull-requests
|
