Contributing

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

Ways you can help

Report Bugs

Report bugs at https://github.com/guillaume-gricourt/HmnFusion/issues.

If you are reporting a bug, please include:

  • Your operating system name and version, versions of HmnFusion

  • 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” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” is open to whoever wants to implement it.

Write Documentation

Same as Implement Features

Submit Feedback

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

  • This will hopefully become a community-driven project and contributions are welcome :)

Pull Request Guidelines

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

  1. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.

  2. Passing pytest

    $ python -m pytest

  3. Passing super-linter

This policy was modified from planemo project