mirror of https://github.com/super-linter/super-linter.git synced 2024-12-22 20:52:12 -05:00

Signed-off-by: Zack Koppert <zkoppert@github.com>

2020-06-17 09:31:45 -07:00

Contributing

👋 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 are used for adding new playbooks, roles, and documents to the repository, or editing the existing ones.

With write access

Clone the repository (only if you have write access)
Create a new branch: git checkout -b my-branch-name
Make your change
Push and submit a pull request
Pat yourself on the back and wait for your pull request to be reviewed and merged.

Without write access

Fork and clone the repository
Create a new branch: git checkout -b my-branch-name
Make your change
Push to your fork and submit a pull request
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.

Draft 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

If you are the current maintainer of this action:

Update README.md to reflect new version number in the suggested workflow file section
Draft Release document explaining details of Release
Look for approval from CODEOWNERS