23 строки
1.5 KiB
Markdown
23 строки
1.5 KiB
Markdown
|
# How to contribute
|
||
|
|
|
||
|
|
This is an open source project, so if you have suggestions for how this project could be improved, or want to report a bug, open an issue! I'd love all and any contributions. You can submit issues and enhancement requests through the [issues page on GitHub](https://github.com/github/rubocop-rails-accessibility/issues). If you have any question, please don't hesitate to contact me, I'd love to hear from you.
|
||
|
|
|
||
|
|
### Contributing guidelines
|
||
|
|
|
||
|
|
In general, I follow the "fork-and-pull" Git workflow:
|
||
|
|
|
||
|
|
1. **Fork and clone** the repo on GitHub.
|
||
|
|
2. **Configure and install** the dependencies `npm install`.
|
||
|
|
3. **Create** a new branch: `git checkout -b branch-name`.
|
||
|
|
4. **Commit** all your changes to your branch. Please write a [good commit message](https://chris.beams.io/posts/git-commit/).
|
||
|
|
5. **Push** your work back up to your fork.
|
||
|
|
6. **Submit a Pull Request** so that I can review your changes. Please add documentation and some details to the PR.
|
||
|
|
|
||
|
|
Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
|
||
|
|
|
||
|
|
## Resources
|
||
|
|
|
||
|
|
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
||
|
|
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
|
||
|
|
- [GitHub Help](https://help.github.com)
|