Skip to content

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

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

To fix bugs, please fork the repository and create a merge request. See also: Merge request.

Implement features

To implement features, please fork the repository and create a merge request. See also: Merge requests.

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.

Write documentation

The package could always use more documentation, whether as a tutorial or how-to guide or in docstrings, as part of the API documentation. Or even on the web in blog posts, articles, and such.

Merge requests

Before you submit a merge request, check that it meets these guidelines:

  • The merge request should include tests for your bugfix or new feature.
  • Make sure that all tests succeed.
  • If the merge 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.md.