submit
- Commit your changes to the branch with a meaningful message.
Use descriptive commit messages (and issue or ticket numbers, if applicable) detailing the content updates you are entering for content. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact." - Set permissions to allow maintainers to edit and update the PR (learn more).
- Push your branch to the forked repo.
- Visit our repo after pushing your branch. If you see an option to Compare & pull request for your branch, click this.
- If you do not see it, create a new PR.
- Select
mainfor the base branch. This is the branch all staging and production content builds from. - Select your branch for the compare.
- Click Create pull request.
- Select
- If you do not see it, create a new PR.
- On the Pull Request page, enter the following:
- Make sure base branch is
mainand compare branch is the one you pushed. - Enter a title for the PR.
- If applicable, include a GitHub issue number (or, for internal Sumos, the Jira ticket number).
- Describe what changed, new pages, updates.
- Apply a label that best describes your contribution.
- Make sure base branch is
- (Optional). For urgent, high-priority PRs (for example, doc edits tied to a GA release happening within 24 hours):
- Add the GA release date to the title. For example,
AWS Integration release (GA: Jan 1, 2023). - From the labels list, select the
hot🔥label, signifying it's an extremely urgent PR. - For internal Sumos only: after completion of all GitHub checks, send your PR link to the
#doc-intand#open-sourceSlack channels for review.
- Add the GA release date to the title. For example,
- Click Create pull request.

- First-time contributors will be prompted in a comment to sign our Contributor License Agreement. We allow individual contributions and contributions made on behalf of companies.
