You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
119 lines
3.0 KiB
119 lines
3.0 KiB
.. highlight:: shell |
|
|
|
============ |
|
Contributing |
|
============ |
|
|
|
Contributions are welcome, and they are greatly appreciated! Every |
|
little bit helps, and credit will always be given. |
|
|
|
You can contribute in many ways: |
|
|
|
|
|
Types of Contributions |
|
---------------------- |
|
|
|
Report Bugs |
|
~~~~~~~~~~~ |
|
|
|
Report bugs at https://git.cpi.imtek.uni-freiburg.de/holgi/ordr2/issues. |
|
|
|
If you are reporting a bug, please include: |
|
|
|
* Your operating system name and version. |
|
* Any details about your local setup that might be helpful in troubleshooting. |
|
* Detailed steps to reproduce the bug. |
|
|
|
|
|
Fix Bugs |
|
~~~~~~~~ |
|
|
|
Look through the GitHub issues for bugs. Anything tagged with "bug" |
|
and "help wanted" is open to whoever wants to implement it. |
|
|
|
|
|
Implement Features |
|
~~~~~~~~~~~~~~~~~~ |
|
|
|
Look through the GitHub issues for features. Anything tagged with "enhancement" |
|
and "help wanted" is open to whoever wants to implement it. |
|
|
|
|
|
Write Documentation |
|
~~~~~~~~~~~~~~~~~~~ |
|
|
|
Ordr2 could always use more documentation, whether as part of the |
|
official Ordr2 docs, in docstrings, or even on the web in blog posts, |
|
articles, and such. |
|
|
|
|
|
Submit Feedback |
|
~~~~~~~~~~~~~~~ |
|
|
|
The best way to send feedback is to file an issue at https://git.cpi.imtek.uni-freiburg.de/holgi/ordr2/issues. |
|
|
|
If you are proposing a feature: |
|
|
|
* Explain in detail how it would work. |
|
* Keep the scope as narrow as possible, to make it easier to implement. |
|
* Remember that this is a volunteer-driven project, and that contributions |
|
are welcome :) |
|
|
|
|
|
Get Started! |
|
------------ |
|
|
|
Ready to contribute? Here's how to set up `ordr2` for local development. |
|
|
|
1. Fork the `ordr2` repo on GitHub. |
|
2. Clone your fork locally:: |
|
|
|
$ git clone https://git.cpi.imtek.uni-freiburg.de/your_name_here/ordr2/ |
|
|
|
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: |
|
|
|
$ mkvirtualenv ordr2 |
|
$ cd ordr2/ |
|
$ python setup.py develop |
|
|
|
4. Create a branch for local development:: |
|
|
|
$ git checkout -b name-of-your-bugfix-or-feature |
|
|
|
Now you can make your changes locally. |
|
|
|
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:: |
|
|
|
$ flake8 ordr2 tests |
|
$ python setup.py test or py.test |
|
$ tox |
|
|
|
To get flake8 and tox, just pip install them into your virtualenv. |
|
|
|
6. Commit your changes and push your branch to GitHub:: |
|
|
|
$ git add . |
|
$ git commit -m "Your detailed description of your changes." |
|
$ git push origin name-of-your-bugfix-or-feature |
|
|
|
7. Submit a pull request through the GitHub website. |
|
|
|
|
|
Pull Request Guidelines |
|
----------------------- |
|
|
|
Before you submit a pull request, check that it meets these guidelines: |
|
|
|
1. The pull request should include tests. |
|
2. If the pull request adds functionality, the docs should be updated. Put |
|
your new functionality into a function with a docstring, and add the |
|
feature to the list in README.rst. |
|
|
|
|
|
Tips |
|
---- |
|
|
|
To run a subset of tests:: |
|
|
|
$ py.test tests.test_ordr2 |
|
|
|
|