mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-24 17:50:58 -05:00
40 lines
2 KiB
Markdown
40 lines
2 KiB
Markdown
|
# Contributing
|
||
|
|
:wave: Hi there!
|
||
|
|
We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
|
||
|
|
|
||
|
|
## Submitting a pull request
|
||
|
|
[Pull Requests][pulls] are used for adding new playbooks, roles, and documents to the repository, or editing the existing ones.
|
||
|
|
|
||
|
|
**With write access**
|
||
|
|
1. Clone the repository (only if you do not have write access)
|
||
|
|
1. Create a new branch: `git checkout -b my-branch-name`
|
||
|
|
1. Make your change
|
||
|
|
1. Push and [submit a pull request][pr]
|
||
|
|
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
|
||
|
|
|
||
|
|
**Without write access**
|
||
|
|
1. [Fork][fork] and clone the repository
|
||
|
|
1. Create a new branch: `git checkout -b my-branch-name`
|
||
|
|
1. Make your change
|
||
|
|
1. Push to your fork and [submit a pull request][pr]
|
||
|
|
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
|
||
|
|
|
||
|
|
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
||
|
|
|
||
|
|
- Keep your change 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.
|
||
|
|
- Write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
||
|
|
|
||
|
|
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you.
|
||
|
|
|
||
|
|
- Create a branch with a name that identifies the user and nature of the changes (similar to `user/branch-purpose`)
|
||
|
|
- Open a pull request and request a review from a member of the appropriate `@github/services-account-engineering` and/or `@github/services-engineering` teams
|
||
|
|
|
||
|
|
## 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)
|
||
|
|
|
||
|
|
[pulls]: https://github.com/github/github-demo-stack/pulls
|
||
|
|
[pr]: https://github.com/github/github-demo-stack/compare
|
||
|
|
[fork]: https://github.com/github/github-demo-stack/fork
|