Open a pull request (PR) on GitHub
- Click the Suggest an Edit link on the documentation page you want to update. This takes you to the page’s source file in GitHub.
Click the Edit this file… pencil icon to edit the file.
- Make your changes in the GitHub markdown editor.
Fill in the Propose file change form.
Explain what your file change is about in a short summary.
Provide a clear description of your change. Do not to leave this field blank. It is helpful to reviewers to have additional context about what you changed.
Click Propose file change. This takes you to the Comparing changes screen so you can review your changes.
Click Create pull request. This takes you to the Open a pull request form.
Fill in the Open a pull request form.
The Title defaults to the file change summary. Update the title so it follows the
<type>(<scope>): <subject>format. Make sure you include a space after the colon. For example:
docs(plugins): add documentation for plugin creators
The Spinnaker repositories use a PR title checker, so your PR will fail if the title is not in the correct format. For more information, see commit message conventions.
- The Leave a comment field defaults to the file change description. PR descriptions are the first step to helping reviewers and project maintainers understand why your change was made. Do not leave this field blank. Provide as much description as possible. A good description helps get your PR merged faster!
- Leave the Allow edits from maintainers checkbox selected.
Click the Create pull request button.
Congratulations! You can view your submitted pull request on the Pull requests tab.
Address feedback in GitHub
Spinnaker community members will review your pull request. If you have a specific person in mind, tag them in the issue comments using the @ symbol and then their GitHub username. Reviewers can request changes, leave comments, or approve the pull request.
What to do if a reviewer asks for changes
- Go to the Files changed tab in GitHub.
- Make the requested changes.
- Commit the changes.
Need help? Get in touch!
Don’t hesitate to reach out to the Docs team if you run into any issues. We’re here to help. Post a message in the
#sig-documentation Slack Channel, and someone will get back to you!