Skip to content

Latest commit

 

History

History
136 lines (81 loc) · 3.93 KB

CONTRIBUTING.rst

File metadata and controls

136 lines (81 loc) · 3.93 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When 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.

Documentation improvements

CDPyR could always use more documentation, whether as part of the official CDPyR docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at cdpyr 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 code contributions are welcome :)

Development

Note this project uses the GitLab flow branching model.

To set up CDPyR for local development:

  1. Fork cdpyr (look for the "Fork" button).

  2. Clone your fork locally:

    $ git clone https://gitlab.com/<your-username>/cdpyr.git

  3. Set up your local development environment by installing tox, creating the dev environment, and setting up git flow

    $ pip install tox
$ tox -e dev

  4. Activate the python environment:

    1. Windows:
    > .venv\Scripts\activate.bat
    1. Unix:
    $ . .venv/bin/activate

  5. Create a branch for local development to make your changes locally:

    $ git checkout -b your-branch-name-should-explain-the-changes

  6. When you're done making changes, run all the checks, doc builder and spell checker with tox one command:

    $ tox

  7. Commit your changes and push your branch to your repository:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin your-branch-name-should-explain-the-changes

  8. Submit a merge request through the GitLab website.

If your change requires changes to the dependencies of cdpyr, then add these in setup.py under install_requires. However, if you make changes to the dependencies of tests or the development environment, then add these dependencies in tox.ini in the deps of either the [testenv] or [testenv:dev] section.

Pull Request Guidelines

If you need some code review or feedback while you're developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox) [1].
  2. Update documentation when there's new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

To build the docs locally to dist/docs:

tox -e docs
[1]If you don't have all the necessary python versions available locally you can rely on GitLab CI - it will run the tests for each change you add in the pull request. It will be slower though ...