Skip to content

Commit

Permalink
chore: add GitHub PR, issue templates (#1487)
Browse files Browse the repository at this point in the history
  • Loading branch information
ahnpnl authored Apr 2, 2020
1 parent 330afe3 commit c1dc228
Show file tree
Hide file tree
Showing 11 changed files with 156 additions and 572 deletions.
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
* @kulshekhar
22 changes: 2 additions & 20 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,6 @@
<!-- First of all, check the troubleshooting wiki page for common issues at:
https://github.com/kulshekhar/ts-jest/wiki/Troubleshooting -->

## Issue <!-- describe the issue below -->:
## 👉 [Please follow one of these issue templates](https://github.com/kulshekhar/ts-jest/issues/new/choose) 👈


## Expected behavior <!-- describe the expected behavior below -->:


## Debug log:
<details/>
<summary>log file content<!-- You can activate the debug logger by setting the environment variable TS_JEST_LOG="ts-jest.log" before running tests. The output of the logger will be in **ts-jest.log** in CWD, paste it in the below section: --></summary>

```bash
# content of ts-jest.log :

```
</details>


## Minimal repo <!-- If you haven't already, create the smallest possible repo that reproduces this issue by running `npm install` and `npm test`. This will speed up any fixes that this issue might need. Paste the minimal repo URL below -->:


<!-- Optional (but highly recommended): Configure Travis (or your favorite system) with the minimal repo. This allows potential solutions to be tested against the minimal repo. This saves everyone time and avoids a lot of back and forth. -->
Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: 🐛 Bug report
labels: ':bug:Bug', Needs Triage, Needs Repo
about: Create a report to help us improve
---

## 🐛 Bug Report

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

## To Reproduce

Steps to reproduce the behavior:

## Expected behavior

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

## Link to repo (highly encouraged)

<!--
Please provide either a minimal repository either on GitHub or GitLab.
Issues without a reproduction link are likely to stall.
-->

## envinfo

```
System:
OS:
Npm packages:
jest:
ts-jest:
typescript:
babel(optional):
```
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: 🚀 Feature Proposal
labels: ':rocket: Feature Request'
about: Submit a proposal for a new feature
---

## 🚀 Feature Proposal

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

## Motivation

<!-- Please outline the motivation for the proposal. -->

## Example

<!-- Please provide an example for how this feature would be used. -->
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: 💬 Questions / Help
label: ':speech_balloon: Question'
about: If you have questions, please check our Slack or StackOverflow
---

## 💬 Questions and Help

### Please note that this issue tracker is not a help forum and this issue will be closed.

For questions or help please see:

- [The ts-jest online documentation](https://kulshekhar.github.io/ts-jest)
- [Our Slack channel](https://bit.ly/3bRHFPQ)
- The [ts-jest](https://stackoverflow.com/questions/tagged/ts-jest) tag on [StackOverflow](https://stackoverflow.com/questions/ask)
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/regression.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: 💥 Regression Report
labels: ':boom: Regression'
about: Report unexpected behavior that worked in previous versions
---

## 💥 Regression Report

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

## Last working version

Worked up to version:

Stopped working in version:

## To Reproduce

Steps to reproduce the behavior:

## Expected behavior

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

## Link to repo (highly encouraged)

<!--
Please provide either a minimal repository either on GitHub or GitLab.
Issues without a reproduction link are likely to stall.
-->

## envinfo

```
System:
OS:
Npm packages:
jest:
ts-jest:
typescript:
babel(optional):
```
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. -->

## Summary

<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->


## Test plan

<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. -->


## Does this PR introduce a breaking change?

- [ ] Yes
- [ ] No

<!-- If this PR contains a breaking change, please describe the impact and migration plan -->


## Other information

1 change: 1 addition & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Please note this issue tracker is not a help forum. We recommend using [StackOverflow](https://stackoverflow.com/questions/tagged/ts-jest) or our [Slack channel](https://bit.ly/3bRHFPQ) for questions.
Loading

0 comments on commit c1dc228

Please sign in to comment.