Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update .github templates #168

Merged
merged 2 commits into from
Jun 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 33 additions & 12 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,49 @@
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
labels: 'bug'
assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.
<!--
Thank you for very much for reporting an issue. Please help to fill in as much as possible for us to have a better context. We welcome you open a PR to fix the issue as well. If you would like to do so. Please add a comment then we will guide you on how to contribute by fixing the issue.
-->

## Describe the bug

<!-- A clear and concise description of what the bug is. -->

## Screenshots

<!-- If applicable, add screenshots to help explain your problem. -->

## Reproduce

<!--
It's extremely important to provide a way to reproduce the bug. A reproducible repository is preferred.

**To Reproduce**
It's extremely helpful to provide a way to reproduce the bug. A reproducible repository is preferred.
If this source code is private, please consider to mask sensitive code and extract a minimum of code that reproduces the bug.

**Expected behavior**
A clear and concise description of what you expected to happen.
Without a reproduction, it's likely that it takes a very long time or the bug will not be fixed.
-->

Please provide a minimal [reproduction](https://stackoverflow.com/help/minimal-reproducible-example) for the issue. Thanks.

## Expected behavior

**Screenshots**
If applicable, add screenshots to help explain your problem.
<!-- A clear and concise description of what you expected to happen. -->

**Environment (please complete the following information)**
## Environment (please complete the following information)

- OS: [e.g. macOS 12.2.1, Windows 11, Ubuntu 22.04]
- Browser: [e.g. chrome, safari]
- Jest version: [e.g. 27.5.1]

**Additional context**
Add any other context about the problem here.
## Additional context

<!-- Add any other context about the problem here. -->

<!--
Last but not least, if we merged a PR to resolve your issue, we would love to credit you by adding you to contributors (https://github.com/nvh95/jest-preview#contributors-).
Usually, we will remember to do that. But sometimes, we forget. Simply ask us to do that if the corresponding PR get merged after 2 days and we still don't have you in the contributors list.
-->
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/example_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Example request
about: Suggest an example of using Jest Preview in real world
title: ''
labels: 'examples'
assignees: ''
---

<!--
Thank you for spending your time suggesting an example.
If you have some use cases that Jest Preview helps you write tests faster, please open an issue and a PR to add it to `examples`.
If you want some frameworks to work with Jest Preview but not sure how to set it up. Just open an issue.
-->

## What is the framework/ technology you want to integrate Jest Preview to?

<!--
Anything frameworks/ libraries that you can write tests for
For examples: Angular/ Vue/ Svelte/ SCSS/ styled-components...
-->

## Useful links

<!-- Any links you think it's useful to have more context. For most of the time it's an official documentation -->

## Do you want to add this example by your own?

<!-- Yes/ I need help to integrate jest-preview to -->

<!--
Last but not least, if we merged a PR to resolve your issue, we would love to credit you by adding you to contributors (https://github.com/nvh95/jest-preview#contributors-).
Usually, we will remember to do that. But sometimes, we forget. Simply ask us to do that if the corresponding PR get merged after 2 days and we still don't have you in the contributors list.
-->
38 changes: 27 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,37 @@
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
labels: 'feature request'
assignees: ''
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
<!--
Thank you for spending your time suggesting a feature that Jest Preview may needs. Please help to fill in as much as possible for us to have a better context. We welcome you open a PR for your own initiatives as well.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
If you want to work on this feature but you don't know where to start. Just open the issue then add a comment that you want to work on this. We will guide you on how to start to contribute.
-->

**Describe how should jest-preview implements this feature**
Do you have any idea how to implement this feature? Please describe the idea or strategy to tackle this problem.
## Is your feature request related to a problem? Please describe.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

**Additional context**
Add any other context or screenshots about the feature request here.
## Describe the solution you'd like

<!-- A clear and concise description of what you want to happen. -->

## Describe how should jest-preview implements this feature

<!-- Do you have any idea how to implement this feature? Please describe the idea or strategy to tackle this problem. -->

## Describe alternatives you've considered

<!-- A clear and concise description of any alternative solutions or features you've considered. -->

## Additional context

<!-- Add any other context or screenshots about the feature request here. -->

<!--
Last but not least, if we merged a PR to resolve your issue, we would love to credit you by adding you to contributors (https://github.com/nvh95/jest-preview#contributors-).
Usually, we will remember to do that. But sometimes, we forget. Simply ask us to do that if the corresponding PR get merged after 2 days and we still don't have you in the contributors list.
-->
36 changes: 26 additions & 10 deletions .github/ISSUE_TEMPLATE/improvement.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,33 @@ labels: ''
assignees: ''
---

**Which feature you want to improve?**
A description to a feature you want to improve. A permanent link to the implementation is a good attachment.
<!--
Thank you for spending your time suggesting an improvement. Please help to fill in as much as possible for us to have a better context.

**What and why you want to improve that feature**
Describe the reason why you want to improve that feature.
We welcome you open a PR for your own initiatives as well.
-->

**Potential bugs/ unexpected behaviors**
A clear and concise description of what you expected to happen.
## Which feature you want to improve?

**How to implement the changes**
Describe the idea on how to improve the feature. Pseudo code is a good way to describe the idea.
<!-- A description to a feature you want to improve. A permanent link to the implementation is a good attachment. -->

**Others**
Do you have anything else you want to share about the improvement?
## What and why you want to improve that feature

<!-- Describe the reason why you want to improve that feature. -->

## Potential bugs/ unexpected behaviors

<!-- A clear and concise description of what you expected to happen. -->

## How to implement the changes

<!-- Describe the idea on how to improve the feature. Pseudo code is a good way to describe the idea. -->

## Others

<!-- Do you have anything else you want to share about the improvement? -->

<!--
Last but not least, if we merged a PR to resolve your issue, we would love to credit you by adding you to contributors (https://github.com/nvh95/jest-preview#contributors-).
Usually, we will remember to do that. But sometimes, we forget. Simply ask us to do that if the corresponding PR get merged after 2 days and we still don't have you in the contributors list.
-->
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
<!--
Hi. If you can see this, thank you very much. Yes. I am talking to you, who is creating a PR to make jest-preview a better library.
We provide a CONTRIBUTING guide at https://www.jest-preview.com/docs/others/contributing. I hope it helps you when setup and start contribute to jest-preview. (You can contribute to CONTRIBUTING as well!)
If you have any questions, let me know at https://twitter.com/hung_dev or https://discord.gg/X5PyPUfemh.
I can wait to welcome you to contributors.
-->

## Summary/ Motivation (TLDR;)

## Related issues

<!-- Add related issue here: E.g: #124-->
Expand Down