Skip to content

Commit 4cada3b

Browse files
Merge pull request #9807 from circleci/fix-pr-template
fix PR template
2 parents 36bcbb9 + 3c0d936 commit 4cada3b

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

.github/pull_request_template.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
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.
1+
> [!NOTE]
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+
> You can ignore lint errors outside your changes and the CircleCI docs team will address them for you.
5+
> 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.
76
87
# Description
98
What did you change?
@@ -15,17 +14,17 @@ Why did you make these changes? What problem does this solve?
1514
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.
1615

1716
**Preview your changes:**
18-
- 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.
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.
17+
- [ ] 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.
18+
- [ ] 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.
2019

2120
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):
2221

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

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

0 commit comments

Comments
 (0)