Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 2.98 KB
Raw

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

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

Without write access

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

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 the @github/ps-delivery team

Releasing

If you are the current maintainer of this action:

  1. Create a Tag
  2. Draft Release document explaining details of Release
  3. Look for approval from CODEOWNERS

Resources