Skip to content

Commit 19ed77b

Browse files
Simplifies issue and PR templates. (#302)
* Simplifies issue and PR templates. * Fixes header level. * Grammar and spelling fixes.
1 parent 8f72174 commit 19ed77b

File tree

2 files changed

+12
-24
lines changed

2 files changed

+12
-24
lines changed

.github/ISSUE_TEMPLATE

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
1-
<!-- Describe the issue you're encountering in detail. -->
1+
<!-- Describe the issue you're encountering. -->
22

33
## Steps to reproduce
44

5-
<!-- Provide a step-by-step explanation of how to reproduce the issue, including the page or section URL (if relevant). -->
5+
<!-- Provide a step-by-step explanation of reproducing the issue, including the page or section URL (if relevant). -->
66

77
## Error messages and/or screenshots
88

99
<!-- Include any relevant error messages, logs, or screenshots. -->
1010

1111
## Proposed solution (optional)
1212

13-
<!-- If you have ideas about how this might be fixed, share them here. -->
13+
<!-- If you have ideas about how the team could fix this issue, share them here. -->
1414

15-
## Checklist
15+
## Final checks
1616

17-
I confirm that I have:
18-
19-
- [ ] Checked to see if there are any existing issue that cover this topic.
20-
- [ ] Linked to any relevant issues across all [entropyxyz](https://github.com/entropyxyz/) repos.
17+
- [ ] I have checked to see if any existing issues cover this topic and linked any other relevant issues.

.github/PULL_REQUEST_TEMPLATE

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,15 @@
1-
<!-- Fill out this template to help us review your pull request. Delete any comments once you are done. -->
1+
## Link issues
22

3-
## Description
3+
<!-- Reference the issue/issues that this PR fixes. All PRs must close an issue. If an issue does not exist, go make one and link it here. -->
44

5-
<!-- Quickly describe the changes you made and why you made them. -->
6-
<!-- Reference the issue/issues that this PR fixes. -->
7-
8-
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
9-
<!-- ALL PRs MUST CLOSE AN ISSUE. IF AN ISSUE DOES NOT EXIST, GO MAKE ONE. -->
10-
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
11-
12-
### Content updates
5+
## Content updates
136

147
<!-- List which pages or sections you have created/updated/deleted in this PR. -->
158

16-
## Documentation updates
9+
## Meta updates
1710

18-
<!-- Have you changed how shortcodes work or how the docs site is rendered? Update the relevant info in this project's `README.md` and/or `CONTRIBUTING.md` files. -->
11+
<!-- Have you changed how shortcodes work or how the docs site is rendered? Update the relevant info in this project's `README.md` and/or `CONTRIBUTING.md` files. This section can be skipped and deleted if your PR contains no meta updates. -->
1912

20-
## Checklist:
13+
## Final checks
2114

22-
- [ ] I have read and followed the `CONTRIBUTING.md` guidelines.
23-
- [ ] I have run these changes through a grammar and spell checker.
24-
- [ ] I have updated the documentation (`README.md`, `CONTRIBUTING.md` etc.) to reflect these changes.
15+
- [ ] I have read and followed the `CONTRIBUTING.md` guidelines and updated the documentation (`README.md`, `CONTRIBUTING.md`, etc.) to reflect these changes.

0 commit comments

Comments
 (0)