Skip to content

Commit 355624e

Browse files
committed
chore(docs): Add issue templates
Add several templates for creating new issues: bug, feature, regression & question. Also updated the PR template with minor changes. Lastly updated the `benmvp create` docs to reflect that they will copy over those templates
1 parent 753566b commit 355624e

File tree

7 files changed

+113
-6
lines changed

7 files changed

+113
-6
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: 🐛 Bug report
3+
labels: bug
4+
about: Create a report to help us improve
5+
---
6+
7+
## 🐛 Bug Report
8+
9+
<!-- A clear and concise description of what the bug is. -->
10+
11+
## To Reproduce
12+
13+
Steps to reproduce the behavior:
14+
15+
## Expected behavior
16+
17+
<!-- A clear and concise description of what you expected to happen. -->
18+
19+
## Link to repl or repo (highly encouraged)
20+
21+
<!--
22+
Please provide either a [repl.it demo](https://repl.it/languages/javascript) or a minimal repository on GitHub.
23+
Issues without a reproduction link are likely to stall.
24+
-->
25+
26+
## `envinfo`
27+
28+
<!--
29+
Run: npx envinfo --system --binaries
30+
Paste the results here:
31+
-->
32+
33+
```bash
34+
35+
```

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: 🚀 Feature Proposal
3+
labels: enhancement
4+
about: Submit a proposal for a new feature
5+
---
6+
7+
## 🚀 Feature Proposal
8+
9+
A clear and concise description of what the feature is.
10+
11+
## Motivation
12+
13+
Please outline the motivation for the proposal.
14+
15+
## Example
16+
17+
Please provide an example for how this feature would be used.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: 💬 Questions / Help
3+
label: question
4+
about: Get help and answers to questions
5+
---
6+
7+
## 💬 Questions and Help
8+
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: 💥 Regression Report
3+
labels: regression
4+
about: Report unexpected behavior that worked in previous versions
5+
---
6+
7+
## 💥 Regression Report
8+
9+
<!-- A clear and concise description of what the regression is. -->
10+
11+
## Last working version
12+
13+
Worked up to version:
14+
15+
Stopped working in version:
16+
17+
## To Reproduce
18+
19+
Steps to reproduce the behavior:
20+
21+
## Expected behavior
22+
23+
<!-- A clear and concise description of what you expected to happen. -->
24+
25+
## Link to repl or repo (highly encouraged)
26+
27+
<!--
28+
Please provide either a [repl.it demo](https://repl.it/languages/javascript) or a minimal repository on GitHub.
29+
Issues without a reproduction link are likely to stall.
30+
-->
31+
32+
## `envinfo`
33+
34+
<!--
35+
Run: npx envinfo --system --binaries
36+
Paste the results here:
37+
-->
38+
39+
```bash
40+
41+
```

.github/pull_request_template.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
## Problem
22

3-
_State the problem the PR is aiming to solve_
3+
<!-- State the problem the PR is aiming to solve -->
44

55

66
## Solution
77

8-
_Outline the solution to the problem_
8+
<!--
9+
Outline the solution to the problem.
910
10-
Fixes #.
11+
If this fixes an existing issue include:
1112
13+
Fixes #<ISSUE_NUM>.
14+
-->
1215

13-
## Screenshots
14-
15-
_Embed any screenshots of the new UI_

docs/api/create.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ It will:
1212
- Add (or overwrite) a `.github/workflows/ci.yml` [Github workflow](https://help.github.com/en/actions) for testing your code when a branch is pushed to or a PR is updated.
1313
- Add (or overwrite) a `.github/workflows/format.yml` [Github workflow](https://help.github.com/en/actions) for formatting your files when a non-`master` branch is pushed to. Formatted code will be pushed as a new commit to the branch.
1414
- Add (or overwrite) a `.github/workflows/release.yml` [Github workflow](https://help.github.com/en/actions) for release a new version of your package with new commits to `master`.
15+
- Add (or overwrite) `.github/pull_request_template.md` & `.github/ISSUE_TEMPLATE/*` for more organized [pull request](https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository) and [issue](https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository) creation.
16+
17+
> NOTE: `create()` can be called multiple times on a repo. It's a good idea to call `create()` every time you bump the version of `@benmvp/cli` so you can get the latest configuration for `package.json`, prettier, Github workflows, and Github PR/Issue templates.
1518
1619
Looking for CLI docs? View companion [`benmvp create` documentation](../cli/create.md).
1720

docs/cli/create.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ It will:
1212
- Add (or overwrite) a `.github/workflows/ci.yml` [Github workflow](https://help.github.com/en/actions) for testing your code when a branch is pushed to or a PR is updated.
1313
- Add (or overwrite) a `.github/workflows/format.yml` [Github workflow](https://help.github.com/en/actions) for formatting your files when a non-`master` branch is pushed to. Formatted code will be pushed as a new commit to the branch.
1414
- Add (or overwrite) a `.github/workflows/release.yml` [Github workflow](https://help.github.com/en/actions) for release a new version of your package with new commits to `master`.
15+
- Add (or overwrite) `.github/pull_request_template.md` & `.github/ISSUE_TEMPLATE/*` for more organized [pull request](https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository) and [issue](https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository) creation.
16+
17+
> NOTE: `benmvp create` can be called multiple times on a repo. It's a good idea to call `create()` every time you bump the version of `@benmvp/cli` so you can get the latest configuration for `package.json`, prettier, Github workflows, and Github PR/Issue templates.
1518
1619
Looking for Node API docs? View companion [`create()` documentation](../api/create.md).
1720

0 commit comments

Comments
 (0)