Skip to content

Commit e95d4ca

Browse files
authored
DOP-0000 adds the pull request template (#12285)
* DOP-0000 adds the pull request template * DOP-0000 from what I can understand this will make the template visible only for platform changes * Adds the DOP template and a blank template for the writers to build out * Fix typo in the README and adds the writing teams template
1 parent 5d21453 commit e95d4ca

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## DESCRIPTION
2+
3+
4+
## STAGING
5+
6+
7+
## JIRA
8+
9+
10+
## SELF-REVIEW CHECKLIST
11+
12+
- [ ] Does each file have 3-5 taxonomy facet tags?
13+
See the [taxonomy tagging instructions](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) and this [example PR](https://github.com/10gen/cloud-docs/pull/5042/files)
14+
- [ ] Is this free of any warnings or errors in the RST?
15+
- [ ] Is this free of spelling errors?
16+
- [ ] Is this free of grammatical errors?
17+
- [ ] Is this free of staging / rendering issues?
18+
- [ ] Are all the links working?
19+
20+
## EXTERNAL REVIEW REQUIREMENTS
21+
22+
[What's expected of an external reviewer?](https://wiki.corp.mongodb.com/display/DE/Reviewing+Guidelines+for+the+MongoDB+Server+Documentation)
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### Stories/Links:
2+
3+
DOP-NNNN
4+
5+
### Notes:
6+
7+
### README updates
8+
9+
- - [ ] This PR introduces changes that should be reflected in the README, and I have made those updates.
10+
- - [ ] This PR does not introduce changes that should be reflected in the README

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Docs Monorepo
2+
3+
### Selecting PR Template
4+
5+
When creating a pull request, you can automatically populate the description with a template by adding a query parameter to the URL. We provide two templates:
6+
7+
- Platform changes: Use `?template=platform.md`
8+
- Content changes: Use `?template=content.md`
9+
10+
For example:
11+
12+
```curl
13+
https://github.com/example/exampleChanges/compare/test?expand=1&template=template.md
14+
```

0 commit comments

Comments
 (0)