2021-10-01 21:39:56 +10:00
|
|
|
|
# Contributing
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
We welcome any feedback and contributions from the community. Please read the
|
|
|
|
|
|
following guidelines to contribute to Rowy.
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
|
|
|
|
|
## Code of conduct
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
We want to have a welcoming and inclusive environment, towards this please read
|
|
|
|
|
|
and follow our
|
|
|
|
|
|
[our code of conduct](https://github.com/rowyio/rowy/blob/main/CODE_OF_CONDUCT.md).
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
Read the documentation on setting up your local development environment
|
|
|
|
|
|
[here](https://docs.rowy.io/setup/install#option-2-manual-install).
|
|
|
|
|
|
|
|
|
|
|
|
Read how to submit a pull request [here](https://docs.rowy.io/contributing).
|
|
|
|
|
|
|
|
|
|
|
|
To get familiar with the project,
|
|
|
|
|
|
[good first issues](https://github.com/rowyio/rowy/projects/3) is a good place
|
|
|
|
|
|
to start.
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
|
|
|
|
|
## Working on existing issues
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
If you are working on an [issue](https://github.com/rowyio/rowy/issues), share
|
|
|
|
|
|
that you are working on it by commenting on the issue and posting a message on
|
|
|
|
|
|
#contributions channel in Rowy's
|
|
|
|
|
|
[Discord](https://discord.com/invite/fjBugmvzZP). This allows others in the
|
|
|
|
|
|
community and the maintainers a chance to provide feedback and guidance before
|
|
|
|
|
|
you spend time working on it.
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
|
|
|
|
|
## File a feature request
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
If you have some interesting idea that will be a good addition to Rowy, then
|
|
|
|
|
|
create a new issue using
|
|
|
|
|
|
[Feature Request Template](https://github.com/rowyio/rowy/issues/new?assignees=&labels=&template=feature_request.md)
|
|
|
|
|
|
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](https://discord.com/invite/fjBugmvzZP). This allows others in the
|
|
|
|
|
|
community and the maintainers a chance to provide feedback and guidance before
|
|
|
|
|
|
you spend time working on it.
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
|
|
|
|
|
## Report an issue
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
You can report all issues through using
|
|
|
|
|
|
[Report A Bug](https://github.com/rowyio/rowy/issues/new?assignees=&labels=&template=bug_report.md)
|
|
|
|
|
|
template. Please provide as much information as possible so that it can be
|
|
|
|
|
|
resolved.
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
|
|
|
|
|
## Review
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
All submissions, including code and copy changes, will require review by project
|
|
|
|
|
|
maintainers.
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
|
|
|
|
|
## Create a pull request
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
When making any pull requests to the repository, please follow these
|
|
|
|
|
|
instructions:
|
|
|
|
|
|
|
|
|
|
|
|
Make sure you’ve read our technical documentation
|
|
|
|
|
|
[here](https://docs.rowy.io/contributing).
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
- Submit your PR to the `develop` branch
|
|
|
|
|
|
- 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
|
2021-10-01 21:39:56 +10:00
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
2022-11-24 19:13:28 +11:00
|
|
|
|
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.
|
