Thank you for considering to contribute to Kraan 🎉👍
This document will provide help on how to go about this. You can contribute in the following ways:
- Reporting bugs
- Suggesting features
- Contributing code
Reporting bugs is an essential part in making kraan better for its end users.
Bugs are reported using GitHub issues. A new Bug Report can be raised here.
When raising bugs please include as much information as possible including steps about how to reproduce the problem and what you expect the behavior to be.
If there is a feature that you would like in kraan then please let us know about it.
Features are also suggested using GitHub Issues. A new Feature enhancement request can be raised here.
Include as much information as possible, understanding the problem that the feature is trying to solve will really help us in understanding the benefit.
Code contributions to kraan are very welcome.
If you need a pointer on where to start you can look at the good first issue and help wanted issues:
- good first issue - small changes that are suitable for a beginner
- help wanted - more involved changes
You can also choose your own issue to work on from this list of available issues.
When choosing an issue to work on its preferable that you choose a issue that is planned for the next milestone and that has a higher priority....but this is just a nice to have and any contribution would be considered and welcomed.
See the Developer Guide.
Commit and push your branch. We follow Conventional Commits for the commits and PRs. If the PR is a work in progress ensure that you prefix the title with WIP:. Create a pull request Check that the PR checks pass
Once a PR has been created it will be reviwed by one of the maintainers of Kraan.