We welcome any feedback and contributions from the community. Please read the following guidelines to contribute to Rowy.
We want to have a welcoming and inclusive environment, towards this please read and follow our our code of conduct.
Read the documentation on setting up your local development environment here.
Read how to submit a pull request here.
To get familiar with the project, good first issues is a good place to start.
Before you get started working on an issue, please make sure to share that you are working on it by commenting on the issue and posting a message on #contributions channel in Rowy's Discord. The maintainers will then assign the issue to you after making sure any relevant information or context in addition is provided before you can start on the task.
Once you are assigned a task, please provide periodic updates or share any questions or roadblocks on either discord or the Github issue, so that the commmunity or the project maintainers can provide you any feedback or guidance as needed. If you are inactive for more than 1-2 week on a issue that was assigned to you, then we will assume you have stopped working on it and we will unassign it from you - so that we can give a chance to others in the community to work on it.
If you have some interesting idea that will be a good addition to Rowy, then create a new issue using Feature Request Template to share your idea. If you are working on this to contribute to the project, then let others in the community and project maintainers know by posting on #contributions channel in Rowy's Discord. This allows others in the community and the maintainers a chance to provide feedback and guidance before you spend time working on it.
You can report all issues through using Report A Bug template. Please provide as much information as possible so that it can be resolved.
All submissions, including code and copy changes, will require review by project maintainers.
When making any pull requests to the repository, please follow these instructions:
Make sure you’ve read our technical documentation here.
- Submit your PR to the
developbranch - Add as much information as possible in your PR's description including link to any related issues.
- Ensure all your commits have clear commit message along with comments in the code as required
By contributing to Rowy, you agree that your contributions will be licensed with the same license that is specified in the repository you are contributing to.