Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.18 KB

CONTRIBUTING.rst

File metadata and controls

38 lines (26 loc) · 1.18 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

Nameless could always use more documentation, whether as part of the official holoaverage 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/niermann/holoaverage/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 :)

Testing

Please note, that the tests included in the tests subdirectory require the example data to be present in the example subdirectory.