-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #188 from microbiomedata/69-create-pr-template-for…
…-docs-repo Implement Pull Request template for `docs` repository
- Loading branch information
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
<!--┌─────────────────────────────────────────────────────────────────────────┐ | ||
│ 1. Summary (required) │ | ||
│ │ | ||
│ Summarize the changes you made on this branch. This is typically a more │ | ||
│ detailed restatement of the PR title. │ | ||
│ │ | ||
│ Example: "On this branch, I updated some links on the homepage." │ | ||
└─────────────────────────────────────────────────────────────────────────┘--> | ||
|
||
On this branch, I ... | ||
|
||
### Details | ||
|
||
<!--┌─────────────────────────────────────────────────────────────────────────┐ | ||
│ 2. Details (optional) │ | ||
│ │ | ||
│ Provide additional information you think readers of this PR will find │ | ||
│ useful. Readers include PR reviewers, other documentation contributors, │ | ||
│ and your future self. Additional information might include motivation, │ | ||
│ rationale, and a description of how things used to be. │ | ||
│ │ | ||
│ Example: "I updated them because they were pointing to a website that │ | ||
│ is no longer being maintained." │ | ||
└─────────────────────────────────────────────────────────────────────────┘--> | ||
|
||
... | ||
|
||
### Related issue(s) | ||
|
||
<!--┌─────────────────────────────────────────────────────────────────────────┐ | ||
│ 3. Related issue(s) (optional) │ | ||
│ │ | ||
│ Link to any GitHub issue(s) this branch was designed to resolve. │ | ||
│ │ | ||
│ Example: "Fixes #12345" │ | ||
└─────────────────────────────────────────────────────────────────────────┘--> | ||
|
||
... | ||
|
||
### Impacted section(s) | ||
|
||
<!--┌─────────────────────────────────────────────────────────────────────────┐ | ||
│ 4. Impacted section(s) (required) │ | ||
│ │ | ||
│ Mark the checkbox next to each section of the documentation website │ | ||
│ that you think will be impacted by the changes on this branch. This │ | ||
│ information might influence who you request review(s) from. │ | ||
└─────────────────────────────────────────────────────────────────────────┘--> | ||
|
||
- [ ] Home: https://docs.microbiomedata.org/ | ||
- [ ] Runtime: https://docs.microbiomedata.org/runtime/ | ||
- [ ] Workflows: https://docs.microbiomedata.org/workflows/ | ||
- [ ] Other |