Skip to content

Commit

Permalink
🔧 Rework issue template (#4984)
Browse files Browse the repository at this point in the history
Inspired from Vitest's template.
  • Loading branch information
dubzzz authored May 14, 2024
1 parent 40da522 commit 5a699ae
Showing 1 changed file with 33 additions and 27 deletions.
60 changes: 33 additions & 27 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,41 @@
<!-- Context of the PR: short description and potentially linked issues -->
**Description**

<!-- ...a few words to describe the content of this PR... -->
<!-- ... -->
<!-- Please provide a short description and potentially linked issues hustifying the need for this PR -->

<!-- Type of PR: [ ] unchecked / [ ] checked -->
<!-- * Your PR is fixing a bug or regression? Check for existing issues related to this bug and link them -->
<!-- * Your PR is adding a new feature? Make sure there is a related issue or discussion attached to it -->

**_Category:_**
<!-- You can provide any additional context to help into understanding what's this PR is attempting to solve: reproduction of a bug, code snippets... -->

- [ ] ✨ Introduce new features
- [ ] 📝 Add or update documentation
- [ ] ✅ Add or update tests
- [ ] 🐛 Fix a bug
- [ ] 🏷️ Add or update types
- [ ] ⚡️ Improve performance
- [ ] _Other(s):_ ...
<!-- Don't forget to add the gitmoji icon in the name of the PR -->
<!-- See: https://gitmoji.dev/ -->
**Checklist**_Don't delete this checklist and make sure you do the following before opening the PR_

<!-- Fixing bugs, adding features... may impact existing ones -->
<!-- in order to track potential issues that could be related to your PR -->
<!-- please check the impacts and describe more precisely what to expect -->
- [ ] The name of my PR follows [gitmoji](https://gitmoji.dev/) specification
- [ ] My PR references one of several related issues (if any)
- [ ] New features or breaking changes must come with an associated Issue or Discussion
- [ ] My PR does not add any new dependency without an associated Issue or Discussion
- [ ] My PR includes bumps details, please run `yarn bump` and flag the impacts properly
- [ ] My PR adds relevant tests and they would have failed without my PR (when applicable)

**_Potential impacts:_**
<!-- More about contributing at https://github.com/dubzzz/fast-check/blob/main/CONTRIBUTING.md -->

<!-- Generated values: Can your change impact any of the existing generators in terms of generated values, if so which ones? when? -->
<!-- Shrink values: Can your change impact any of the existing generators in terms of shrink values, if so which ones? when? -->
<!-- Performance: Can it require some typings changes on user side? Please give more details -->
<!-- Typings: Is there a potential performance impact? In which cases? -->
**Advanced**

- [ ] Generated values
- [ ] Shrink values
- [ ] Performance
- [ ] Typings
- [ ] _Other(s):_ ...
<!-- How to fill the advanced section is detailed below! -->

- [ ] Category: ...
- [ ] Impacts: ...

<!-- [Category] Please use one of the categories below, it will help us into better understanding the urgency of the PR -->
<!-- * ✨ Introduce new features -->
<!-- * 📝 Add or update documentation -->
<!-- * ✅ Add or update tests -->
<!-- * 🐛 Fix a bug -->
<!-- * 🏷️ Add or update types -->
<!-- * ⚡️ Improve performance -->
<!-- * _Other(s):_ ... -->

<!-- [Impacts] Please provide a comma separated list of the potential impacts that might be introduced by this change -->
<!-- * Generated values: Can your change impact any of the existing generators in terms of generated values, if so which ones? when? -->
<!-- * Shrink values: Can your change impact any of the existing generators in terms of shrink values, if so which ones? when? -->
<!-- * Performance: Can it require some typings changes on user side? Please give more details -->
<!-- * Typings: Is there a potential performance impact? In which cases? -->

0 comments on commit 5a699ae

Please sign in to comment.