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 at https://github.com/Abstract-Tech/derex.runner/issues.
If possible, provide a minimal derex project to trigger the bug.
The best way to send feedback is to file an issue at https://github.com/Abstract-Tech/derex.runner/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 :)
Ready to contribute? Here’s how to set up derex.runner for local development.
Fork the derex.runner repo on GitHub.
Clone your fork locally:
$ git clone email@example.com:your_name_here/derex.runner.git
Activate a virtualenv for this project (we recommend direnv) and install derex.runner there:
$ cd derex.runner/ $ direnv allow # Or, alternatively, activate a pristine python>=3.6 virtualenv $ pip install -r requirements_dev.txt -e . $ python setup.py develop
Install git pre commit hooks:
$ pre-commit install
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that all tests still pass:
$ pytest -m "not slowtest" # will run only the faster tests $ pytest -m "slowtest" # will run only the slow tests
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
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
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.
A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bumpversion patch # possible: major / minor / patch $ git push $ git push --tags