Skip to content

Commit

Permalink
Improves issue and PR templates. (#286)
Browse files Browse the repository at this point in the history
* Improves issue template.

Adds a few more fields into the issue template, renames headers, adds a
checklist that every issue must fill out, and just generally organizes
the template a bit better.

* Improves issue template. Fixes errors in PR template.

* Minor fixes to issue and PR templates.
  • Loading branch information
johnnymatthews authored Dec 18, 2024
1 parent 841128b commit 673c976
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 24 deletions.
23 changes: 11 additions & 12 deletions .github/ISSUE_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
<!-- Before submitting an issue, please review the project documentation and search for existing issues. The more details you provide, the easier it will be to diagnose and address the issue. Remove this line before submitting your issue. -->
<!-- Describe the issue you're encountering in detail. -->

Describe the issue you're encountering in detail.
## Steps to reproduce

**Issue type**: (Select one)
<!-- Provide a step-by-step explanation of how to reproduce the issue, including the page or section URL (if relevant). -->

- [ ] Bug
- [ ] Question
- [ ] Improvement
## Error messages and/or screenshots

**Steps to reproduce**:
<!-- Include any relevant error messages, logs, or screenshots. -->

Provide a step-by-step explanation of how to reproduce the issue.
## Proposed solution (optional)

**Error messages**:
<!-- If you have ideas about how this might be fixed, share them here. -->

Include any relevant error messages, logs, or screenshots.
## Checklist

**Expected behavior**:
I confirm that I have:

What were you expecting to happen? This may seem like a silly question, but please be specific.
- [ ] Checked to see if there are any existing issue that cover this topic.
- [ ] Linked to any relevant issues across all [entropyxyz](https://github.com/entropyxyz/) repos.
23 changes: 11 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,23 @@

## Description

<!-- - Quickly describe the changes you made and why you made them. -->
<!-- - Reference the issue/issues that this PR fixes. -->
<!-- Quickly describe the changes you made and why you made them. -->
<!-- Reference the issue/issues that this PR fixes. -->

<!-- - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- - ALL PRs MUST CLOSE AN ISSUE. IF AN ISSUES DOES NOT EXIST, GO MAKE ONE. -->
<!-- - !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- ALL PRs MUST CLOSE AN ISSUE. IF AN ISSUE DOES NOT EXIST, GO MAKE ONE. -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->

## Breaking changes
### Content updates

<!-- - Does your pull request introduce any breaking changes? If so, please list them clearly and explain how they will affect users.-->
<!-- List which pages or sections you have created/updated/deleted in this PR. -->

## Documentation updates

<!-- - Reference any updates to the documentation within this repo.-->
<!-- - Link to your PR that updates documentation in other repos, like github.com/entropyxyz/entropy-docs-->
<!-- 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. -->

## Checklist:

- [ ] I have added tests for my changes.
- [ ] I have updated the documentation (README, etc.) to reflect the changes.
- [ ] I have read and followed the CONTRIBUTE.md guidelines.
- [ ] I have read and followed the `CONTRIBUTING.md` guidelines.
- [ ] I have run these changes through a grammar and spell checker.
- [ ] I have updated the documentation (`README.md`, `CONTRIBUTING.md` etc.) to reflect these changes.

0 comments on commit 673c976

Please sign in to comment.