Skip to content

Commit

Permalink
Add step
Browse files Browse the repository at this point in the history
  • Loading branch information
joaniefromtheblock authored May 22, 2024
1 parent e29bb1b commit db37f44
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions docs/contribute/submit-a-contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,20 @@ To contribute changes:
```bash
git clone <FORKED-REPO-URL>
```

5. [Add an upstream remote.](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository)

5. Change directories into the cloned forked repository.

```bash
cd <name-of-your-forked-repo>
```

6. [Add an upstream remote.](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository)

```bash
git remote add upstream <ORIGINAL-REPO-URL>
```

6. [Create and checkout a topic branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging),
7. [Create and checkout a topic branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging),
naming it appropriately.
We recommend including the issue number and a short description in the branch name (for example,
`183-doc-cli-option`), which is a reminder to fix only one issue in a PR.
Expand All @@ -64,7 +70,7 @@ To contribute changes:
You can use a Git client such as [Fork](https://fork.dev/) instead of the command line.
:::

7. Open the repository in a text editor of your choice (for example, [VS Code](https://code.visualstudio.com/))
8. Open the repository in a text editor of your choice (for example, [VS Code](https://code.visualstudio.com/))
and make your documentation changes.
Make sure to [follow the style guidelines](style-guide.md) and [format your Markdown correctly](./format-markdown.md).

Expand All @@ -73,9 +79,9 @@ To contribute changes:
[redirect](../create/configure-docusaurus.md#redirects).
:::

8. [Preview your changes locally](preview.md) to check that the changes render correctly.
9. [Preview your changes locally](preview.md) to check that the changes render correctly.

9. Add and commit your changes, briefly describing your changes in the commit message.
10. Add and commit your changes, briefly describing your changes in the commit message.
Push your changes to the remote origin.

```bash
Expand All @@ -84,22 +90,22 @@ To contribute changes:
git push origin
```

10. On the original repository on GitHub, you’ll see a banner prompting you to create a PR with your
11. On the original repository on GitHub, you’ll see a banner prompting you to create a PR with your
recent changes.
Create a PR, describing your changes in detail.
[Link the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
that your PR fixes by adding `fixes #<ISSUE-NUM>` to the PR description.

11. If your PR fails any checks, displayed at the bottom of the PR page, fix those errors.
12. If your PR fails any checks, displayed at the bottom of the PR page, fix those errors.
If you want to include a new word that causes a [spell check](../configure/spell-check.md) error,
you can add that word to the [`project-words.txt`](../create/repo-structure.md#-project-wordstxt) file.

12. For most doc repositories, specific reviewers are automatically requested when you submit a PR.
13. For most doc repositories, specific reviewers are automatically requested when you submit a PR.
You can request additional reviewers in the right sidebar of your PR – for example, the original
issue raiser.
Make any required changes to your PR based on reviewer feedback, repeating steps 7–9.

13. After your PR is approved by two reviewers, all checks have passed, and your branch has no
14. After your PR is approved by two reviewers, all checks have passed, and your branch has no
conflicts with the main branch, you can merge your PR.
If you don't have merge access, a maintainer will merge your PR for you.
You can delete the topic branch after your PR is merged.
Expand Down

0 comments on commit db37f44

Please sign in to comment.