Skip to content

Commit da8c5ec

Browse files
Merge pull request #9793 from circleci/fix-pr-template
Fix pr template
2 parents f7a62c3 + 6d18b7c commit da8c5ec

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

.github/pull_request_template.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
> [!NOTE]
2-
> You may find that there are errors for the `vale/lint` job that are unrelated to your change. Our prose linter checks the whole file when a change is made so if there are existing issues on the page they will be flagged. You can just leave these errors and the CircleCI docs team will address them for you. Our prose linter is advisory to help all contributors create content that conforms to our style guide. The linter feedback is advisory only and will not prevent changes from being published.
1+
2+
You may find that there are errors for the `vale/lint` job that are unrelated to your change.
3+
Vale checks the whole file when a change is made so if there are existing issues on the page they will be flagged.
4+
5+
You can just leave these errors and the CircleCI docs team will address them for you.
6+
Vale logs are advisory to help all contributors create content that conforms to our style guide. The `vale/lint` job will not prevent changes from being published.
37

48
# Description
59
What did you change?
6-
<!-- Example: Added a new troubleshooting section for Docker executor authentication issues -->
710

811
# Reasons
912
Why did you make these changes? What problem does this solve?
10-
<!-- Example: Users were reporting confusion about Docker authentication errors, and we had no documentation addressing this -->
1113

1214
# Content checks
1315
Please follow our style when contributing to CircleCI docs. View our [style guide](https://circleci.com/docs/style/style-guide-overview) or check out our [CONTRIBUTING.md](../CONTRIBUTING.md) for more information.
1416

1517
**Preview your changes:**
1618
- To view the Vale linter results, select the `ci/circleci: lint` job at the bottom of your PR. You will be redirected to the `vale/lint` job output in CircleCI.
17-
- To preview your changes, select the `ci/circleci: build` job at the bottom of your PR, then select the Artifacts tab and select `index.html` to open a preview version of the docs site built for your latest commit.
19+
- To preview your changes, select the `ci/circleci: build` job at the bottom of your PR and you will be redirected to CircleCI. Select the Artifacts tab and select `index.html` to open a preview version of the docs site built for your latest commit.
1820

1921
Take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs):
2022

2123
**Content structure:**
22-
- [ ] Break up walls of text by adding paragraph breaks.
23-
- [ ] Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
24-
- [ ] Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
25-
- [ ] Include relevant backlinks to other CircleCI docs/pages.
24+
- Break up walls of text by adding paragraph breaks.
25+
- Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
26+
- Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
27+
- Include relevant backlinks to other CircleCI docs/pages.
2628

2729
**Formatting:**
28-
- [ ] Keep the title between 20 and 70 characters.
29-
- [ ] Check all headings h1-h6 are in sentence case (only first letter is capitalized).
30+
- Keep the title between 20 and 70 characters.
31+
- Check all headings h1-h6 are in sentence case (only first letter is capitalized).

0 commit comments

Comments
 (0)