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://github.com/cadwrdeltamodeling/suxarray/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.

Please create a PR with the bug fix and the test for the bug.

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

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

We use Sphinx for documentatation with reStructuredText format. The documentation is in the docs directory.

We follow numpydoc style for docstrings. You can find the details at https://numpydoc.readthedocs.io/en/latest/format.html.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/cadwrdeltamodeling/suxarray/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 :)

Pull Request Guidelines

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

  1. Please run tests before submitting a PR. You can run tests with the following command

$ pytest tests

  1. If the pull request adds functionality, please update documentations and add tests for it.