Skip to content

Commit 229cf1d

Browse files
committed
add github templates
1 parent 9746132 commit 229cf1d

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**What needs to get done?**
2+
3+
- Describe the issue or task that needs work
4+
5+
**Why does it need to get done?**
6+
7+
- Explain the importance/urgency of the task
8+
9+
**How do I do it?**
10+
11+
- Give a quick explanation for how someone could do it.
12+
- If it's a repeat task or just more complex, write some step-by-step instructions below to help walk them through it.
13+
14+
<details>
15+
<summary>Setup</summary>
16+
17+
- Clone the repo by running `git clone https://github.com/segmentio/niffy.git`
18+
- Run `npm install`
19+
- Run tests with `make tests` (tests will "fail" for now, as expected)
20+
21+
</details>

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
**Which issue or problem is this solving?**
2+
3+
- Please link to a Github issue that describes the what/why
4+
- If there's no issue, let us know what it is & why you made it
5+
6+
**Remaining tasks**
7+
8+
- [ ] Let us know if there's anything else you need to do
9+
- [ ] That way we can have open status updates
10+
- [ ] And maybe get others to help
11+
12+
**Request for comments**
13+
14+
- Describe what you'd like feedback on or if this is just something to get approved & merged

0 commit comments

Comments
 (0)