Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 2.6 KB

CONTRIBUTING.rst

File metadata and controls

87 lines (57 loc) · 2.6 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

pycollect could always use more documentation, whether as part of the official pycollect 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 https://github.com/allrod5/pycollect/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

To set up pycollect for local development:

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

  2. Clone your fork locally:

    git clone git@github.com:allrod5/pycollect.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. Create a virtual environment and install the project's dependencies:

    make environment
make requirements

  5. When you're done making changes, run black, all the checks and tests, doc builder and spell checker with make commands:

    make black
make checks
make tests
make github-pages

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

  2. Submit a pull request through the GitHub website.

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 make tests) [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.
[1]

If you don't have all the necessary python versions available locally you can rely on GitHub Actions - it will run the tests for each change you add in the pull request.

It will be slower though...