superlint/.github/CONTRIBUTING.md

29 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2019-10-21 10:12:50 -04:00
# Contributing
2020-07-21 13:08:05 -04:00
2019-10-21 10:12:50 -04:00
:wave: Hi there!
We're thrilled that you'd like to contribute to this project.
Your help is essential for keeping it great.
2019-10-21 10:12:50 -04:00
## Submitting a pull request
2020-07-21 13:08:05 -04:00
We use [pull requests](https://github.com/super-linter/super-linter/pulls) to
contribute new features, fixes, or documentation.
Here are a few things you can do that will increase the likelihood of your pull
request being accepted:
2020-07-21 13:08:05 -04:00
- Keep your change as focused as possible. If there are multiple changes you
would like to make that are not dependent upon each other, submit them as
separate pull requests.
- Write [descriptive commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
Draft pull requests are also welcome to get feedback early on, or if there is
something blocking you.
2020-04-28 14:52:11 -04:00
2019-10-21 10:12:50 -04:00
## Resources
2020-07-21 13:08:05 -04:00
2019-10-21 10:12:50 -04:00
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
- [GitHub Help](https://docs.github.com/en)