mirror of
https://github.com/rowyio/rowy.git
synced 2025-12-29 00:16:39 +01:00
Merge branch 'develop' into rc
This commit is contained in:
@@ -1,42 +1,73 @@
|
||||
# Contributing
|
||||
|
||||
We welcome any feedback and contributions from the community. Please read the following guidelines to contribute to Rowy.
|
||||
We welcome any feedback and contributions from the community. Please read the
|
||||
following guidelines to contribute to Rowy.
|
||||
|
||||
## Code of conduct
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
## Getting started
|
||||
|
||||
Read the documentation on getting started [here](http://docs.rowy.io/). To get familiar with the project, [good first issues](https://github.com/rowyio/rowy/projects/3) is a good place to start.
|
||||
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.
|
||||
|
||||
## Working on existing issues
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## File a feature request
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Report an issue
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Review
|
||||
|
||||
All submissions, including code and copy changes, will require review by project maintainers.
|
||||
All submissions, including code and copy changes, will require review by project
|
||||
maintainers.
|
||||
|
||||
## Create a pull request
|
||||
|
||||
When making any pull requests to the repository, please follow these instructions:
|
||||
When making any pull requests to the repository, please follow these
|
||||
instructions:
|
||||
|
||||
- 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
|
||||
Make sure you’ve read our technical documentation
|
||||
[here](https://docs.rowy.io/contributing).
|
||||
|
||||
- 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
|
||||
|
||||
## License
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user