Skip to content

Commit 686cff3

Browse files
add codeowners, issue templates and PR template (#162)
1 parent 1ab2642 commit 686cff3

File tree

9 files changed

+105
-0
lines changed

9 files changed

+105
-0
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* @circleci/docs @circleci/docs-friends @circleci/lifecycle @circleci/product-mgmt-product-experience
2+

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Bug
3+
about: A technical problem
4+
---
5+
6+
# Description
7+
Describe the bug you found.
8+
9+
# Location
10+
Describe where you caught the bug.
11+
If the bug occurs in a specific document,
12+
add the link here.
13+
14+
# Steps to Reproduce
15+
Describe the steps you took to produce the bug.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Grammatical Error
3+
about: Grammatically incorrect writing
4+
---
5+
6+
# Location
7+
A link to the document with the error.
8+
9+
# Error Details
10+
A brief description of the error.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Inconsistent
3+
about: Conflicting information
4+
---
5+
6+
# Locations
7+
Add a link to the document (or documents)
8+
with the conflicting documentation.
9+
10+
# Conflict Description
11+
Describe the conflicting documentation.

.github/ISSUE_TEMPLATE/incorrect.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Incorrect
3+
about: Incorrect information
4+
---
5+
6+
# Locations
7+
Add a link to the document
8+
with the incorrect information.
9+
10+
# Details
11+
Describe the incorrect information in the document.
12+
Extra evidence like build output or other links
13+
is helpful in "proving" that documentation isn't correct.

.github/ISSUE_TEMPLATE/typo.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Typo
3+
about: A typographical error
4+
---
5+
6+
# Location
7+
A link to the document with the typo.
8+
9+
# Error Details
10+
A description of the typo.

.github/ISSUE_TEMPLATE/unclear.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Unclear
3+
about: Confusing language
4+
---
5+
6+
# Location
7+
A link to the document that is unclear.
8+
9+
# Explanation
10+
Describe what confused you about the document.
11+
This could be syntax, word choice, sentence length, or something entirely different.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Undocumented
3+
about: Missing information
4+
---
5+
6+
# Missing Information
7+
Give a brief overview of the information you were looking for.
8+
9+
# Already Looked
10+
Provide a list of places you've already looked for this information.
11+
Links are much appreciated.
12+
13+
# Potential Locations
14+
Tell us where you would expect to find this information.
15+
This can be either an existing document,
16+
or an entirely new document.

.github/pull_request_template.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Description
2+
What did you change?
3+
4+
# Reasons
5+
Why did you make these changes?
6+
7+
# Content Checklist
8+
Please follow our style when contributing to CircleCI docs. Our style guide is here: [https://circleci.com/docs/style/style-guide-overview](https://circleci.com/docs/style/style-guide-overview).
9+
10+
Please 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):
11+
12+
- [ ] Break up walls of text by adding paragraph breaks.
13+
- [ ] Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
14+
- [ ] Keep the title between 20 and 70 characters.
15+
- [ ] Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
16+
- [ ] Check all headings h1-h6 are in sentence case (only first letter is capitalized).
17+
- [ ] Include relevant backlinks to other CircleCI docs/pages.

0 commit comments

Comments
 (0)