Skip to content

Commit

Permalink
Merge pull request #188 from microbiomedata/69-create-pr-template-for…
Browse files Browse the repository at this point in the history
…-docs-repo

Implement Pull Request template for `docs` repository
  • Loading branch information
eecavanna authored Feb 7, 2025
2 parents 3722a20 + df4ef98 commit ee6f9db
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/pull_request_template.md
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

0 comments on commit ee6f9db

Please sign in to comment.