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
Thank you for considering contributing to the Spinnaker project's documentation. This is a working document, be sure to check back soon for updates and additions.
3
+
4
+
## Get Started
5
+
Let's start with gathering our existing contributor guidelines.
6
+
7
+
Relevant resources for Spinnaker contributors:
8
+
-[Code of Conduct](https://spinnaker.io/docs/community/contributing/code-of-conduct/)
Once you join Slack, make yourself at home! Feel free to ask questions, start conversations, and flag issues that need attention. Join the #sig-contributor-experience channel to receive a warm welcome.
17
+
18
+
Browse the channels that start with "sig-" to see the project's special interest groups (SIGs). More information on all of the approved SIGs can be found in the [governance repository](https://github.com/spinnaker/governance).
1. 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:
33
33
34
34
```
35
35
docs(plugins): add documentation for plugin creators
36
36
```
37
37
38
-
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](/community/contributing/submitting/#commit-message-conventions).
38
+
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]({{< ref "submitting#commit-message-conventions" >}}).
39
39
40
40
2. 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!
41
41
3. Leave the **Allow edits from maintainers** checkbox selected.
42
42
43
43
1. Click the **Create pull request** button.
44
44
45
-
Congratulations! You can view your submitted pull request on the **Pull requests** [tab](https://github.com/spinnaker/spinnaker.github.io/pulls).
45
+
Congratulations! You can view your submitted pull request on the **Pull requests** [tab](https://github.com/spinnaker/spinnaker.io/pulls).
Copy file name to clipboardExpand all lines: content/en/docs/community/contributing/docs/local-clone.md
+1-5
Original file line number
Diff line number
Diff line change
@@ -150,19 +150,15 @@ hugo server
150
150
151
151
1. In a web browser, go to the `spinnaker/spinnaker.io` [repository](https://github.com/spinnaker/spinnaker.io). You should see your recently pushed working branch with a **Compare & pull request** button.
1. The **Title** defaults to the commit subject. Update the title so it follows the `<type>(<scope>): <subject>` format. Make sure you include a space after the colon. For example:
160
156
161
157
```
162
158
docs(plugins): add documentation for plugin creators
163
159
```
164
160
165
-
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](/community/contributing/submitting/#commit-message-conventions).
161
+
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]({{< ref "submitting#commit-message-conventions">}}).
166
162
167
163
2. The **Leave a comment** field defaults to the commit description. Pull request 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!
168
164
3. Leave the **Allow edits from maintainers** checkbox selected.
Copy file name to clipboardExpand all lines: content/en/docs/community/contributing/docs/reviewing-prs.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,17 @@ sidebar:
7
7
8
8
## Review a Pull request
9
9
10
-
Anyone can review a documentation pull request (PR). Visit the [**Pull requests**](https://github.com/spinnaker/spinnaker.github.io/pulls) section in the Spinnaker website repository to see a list of all currently open pull requests.
10
+
Anyone can review a documentation pull request (PR). Visit the [Pull requests](https://github.com/spinnaker/spinnaker.io/pulls) section in the Spinnaker website repository to see a list of all currently open pull requests.
11
11
12
12
Reviewing documentation pull requests is a great way to get started contributing to the Spinnaker community. It helps you to learn the code base and builds rapport with other contributors.
13
13
14
14
## Before you begin
15
15
16
16
Before reviewing documentation, do the following:
17
17
18
-
Read the [documentation style guide](/community/contributing/docs/docs-style-guide/) so that you can leave informed feedback.
18
+
Read the [documentation style guide]({{< ref "docs-style-guide" >}}) so that you can leave informed feedback.
19
19
20
-
1. Review the [code of conduct](https://github.com/spinnaker/spinnaker.github.io/blob/master/community/contributing/code-of-conduct.md) and ensure that you abide by it at all times.
20
+
1. Review the [Code of Conduct]({{< ref "code-of-conduct" >}}) and ensure that you abide by it at all times.
21
21
2. Be polite, helpful, and considerate of others.
22
22
3. Comment on positive aspects of a PR, as well as changes.
23
23
4. Be empathetic and mindful of how your changes or review may be received.
@@ -28,7 +28,7 @@ Read the [documentation style guide](/community/contributing/docs/docs-style-gui
28
28
29
29
## Start the review process
30
30
31
-
1. Go to (<https://github.com/spinnaker/spinnaker.github.io/pulls>) to see a list of all current open PRs in the Spinnaker repository.
31
+
1. Go to (<https://github.com/spinnaker/spinnaker.io/pulls>) to see a list of all current open PRs in the Spinnaker repository.
32
32
33
33
2. Filter the open PRs using one or all of the following labels:
34
34
@@ -64,7 +64,7 @@ When reviewing a PR, use the following questions as a starting point:
64
64
- Are there any obvious errors in grammar or language?
65
65
- Is there a better way to phrase something?
66
66
- Are there words, phrases, or terms that should be replaced with a non-discriminatory alternative?
67
-
- Does the word choice, punctuation, and capitalization follow the [style guide](/community/contributing/docs/docs-style-guide/)?
67
+
- Does the word choice, punctuation, and capitalization follow the [style guide]({{< ref "docs-style-guide" >}})?
68
68
- Are there long sentences which could be shorter or made less complex?
69
69
- Are there long paragraphs which would work better as a bulleted list or table?
0 commit comments