You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,8 @@ Before you begin:
10
10
11
11
* You must have a GitHub account.
12
12
13
+
Take these steps:
14
+
13
15
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).
14
16
2. Click **New issue**.
15
17
3. Select **Bug report** or **Enhancement request**.
@@ -83,16 +85,28 @@ To submit an update:
83
85
```
84
86
85
87
7. Open a pull request.
86
-
88
+
87
89
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.
88
90
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
+
91
105
## Building the guide
92
106
93
107
You must have `asciidoctor` installed.
94
108
95
-
1. Navigate to the `supplementary_style_guide` directory.
109
+
1. Navigate to the `supplementary_style_gde` directory.
0 commit comments