Contributing Guidelines

Contributing to Kuro

Thank you for taking the time to contribute to Kuro! Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How to contribute

Improve documentation

Typo corrections, error fixes, better explanations, more examples etc. Open an issue regarding anything that you think could be improved! You can use the documentation📖 label to find out what others have suggested!

Improve issues

Sometimes reported issues lack information, are not reproducible, or are even plain invalid. Help us out to make them easier to resolve. Handling issues takes a lot of time that we would rather spend on fixing bugs and adding features.

Give feedback on issues

We're always looking for more opinions on discussions in the issue tracker or discussions. It's a good opportunity to influence the future direction of the project. Checkout our Discussions Help page to help other users with Kuro. Also feel free to check our Issues page for any help wanted🙏 labeled issues

Write code

You can use labels to discover issues you could help us out with.

Labels

These are the existing

• enhancement👌 are enhancements to already existing features
• bug🐛 are known bugs we would like to fix
• feature🚀 an entirely new feature we intend to develop
• style🎨 is used for styling issues & improvements
• wontfix❌ is used for issues that will not be picked up
• help wanted🙏 are issues that for some reason I cannot do myself but would welcome assistance with.

Please use our Issue Templates when opening a new issue. I am automatically tagged in Questions & Bugs template Issues

Submitting an issue

• Search the issue tracker before opening an issue
• Ensure you're using the latest version of Kuro (Quick cheat)
• Use a descriptive title
• Include as much information as possible;
  • Steps to reproduce the issue
  • App settings
  • Error message
  • Kuro version
  • Operating system etc

Submitting a pull request

• Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work
• Try making the pull request to master branch.
• Use a descriptive title for the pull request and commits.
• You might be asked to do changes to your pull request, you can do that by just updating the existing one