Skip to content

Contributing

RobbWatershed edited this page Jul 9, 2023 · 10 revisions

Contributing to Hentoid

Did you find a bug?

  • 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, and an executable test case demonstrating the expected behavior that is not occurring. Follow the included template if unsure.

  • If possible, use the relevant bug report templates to create the issue. Templates have been provided and are set up for automatic insertion whenever a new issue has been created, simply follow the same format and replace the text where needed.

  • For more detailed information on submitting a bug report and creating an issue, visit our reporting guidelines page.

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. Follow the included template if unsure.

  • Before submitting - have you read our code and acquired a grasp for the style it follows? Any PR submitted code should follow that same style. Additionally, Hentoid is open source software - consider the people who will read your code, and make it look nice for them.

Do you intend to add a new feature or change an existing one?

  • Suggest your change on our Discord Server.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code?

Do you want to contribute to the documentation?

Hentoid is a volunteer effort. We encourage you to pitch in at any time, no matter how small.

Thanks! ❤️ ❤️ ❤️