Skip to content

Commit 7cf78eb

Browse files
authored
Merge pull request #563 from redhat-documentation/IngridT1-patch-3
Update CONTRIBUTING.md
2 parents 705da32 + 71eecf8 commit 7cf78eb

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Before you begin:
1010

1111
* You must have a GitHub account.
1212

13+
Take these steps:
14+
1315
1. From the main page of the [GitHub repository](https://github.com/redhat-documentation/supplementary-style-guide), open the [Issues tab](https://github.com/redhat-documentation/doc-style/issues).
1416
2. Click **New issue**.
1517
3. Select **Bug report** or **Enhancement request**.
@@ -83,16 +85,28 @@ To submit an update:
8385
```
8486

8587
7. Open a pull request.
86-
88+
8789
Typically the previous command gives the URL to open a pull request. If not, you can open one from the [Pull requests](https://github.com/redhat-documentation/supplementary-style-guide/pulls) tab of the GitHub UI.
8890

89-
After you submit a pull request, at least **one** repository administrator must review and approve the content changes.
90-
After your PR has one approval, a repository administrator will merge your PR to the `main` branch.
91+
After you submit a pull request, a preview URL is automatically generated. You can open that URL to see if your change is formatted corretly.
92+
93+
At least **one** repository administrator must review and approve the content changes. After your PR has one approval, a repository administrator will merge your PR to the `main` branch.
94+
95+
## Associating the PR with an issue
96+
97+
Associating the PR with an issue ensures that any changes to the GitHub repo are properly tracked.
98+
99+
To associate your PR with the issue number in the GitHub web interface:
100+
101+
1. Open your PR.
102+
2. In the right-hand sidebar, go to the Development section, click the gear icon, and select **Link an issue**.
103+
3. Select the issue from the list.
104+
91105
## Building the guide
92106

93107
You must have `asciidoctor` installed.
94108

95-
1. Navigate to the `supplementary_style_guide` directory.
109+
1. Navigate to the `supplementary_style_gde` directory.
96110
2. Use the following command to build the guide:
97111

98112
```

0 commit comments

Comments
 (0)