Contributing

This project follows the OpenG2P-ng Code of Conduct. If you are not familiar with our code of conduct policy, take a minute to read the policy before starting with your first contribution.

Bug reports and code and documentation patches are welcome. You can help this project also by using the development version and by reporting any bugs you might encounter.

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability in OpenG2P-ng, and instead contact directly the maintainers of the project.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you’re unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you have questions about the source code?

  • Ask any question about how to use OpenG2P-ng in the Discussions.

Thanks!