Skip to content

Commit 2691900

Browse files
committed
f/github-templates
1 parent 056a3eb commit 2691900

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

.github/CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing to this Project
2+
3+
For pull requests to be merged, authors should:
4+
5+
* Write any applicable unit tests
6+
* Add any relevant documentation
7+
* Reference any relevant issues
8+
* Obtain a review from a team member

.github/ISSUE_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
For bugs, please include the following:
2+
3+
* What is the expected behavior?
4+
* What is the actual behavior?
5+
* What steps reproduce the behavior?
6+
7+
For features, please specify at least minimal requirements, e.g.:
8+
9+
* "As a user, I want a notification badge showing unread count, so I can easily manage my messages"
10+
* "As a developer, I want linting to work properly with JSX, so I can see when there is a mistake"
11+
* "As an admin, I want a management panel for users, so I can delete spurious accounts"
12+
13+
---
14+
15+
*Issue description here…*

.github/PULL_REQUEST_TEMPLATE.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Assignee Tasks
2+
3+
- [ ] added unit tests (or none needed)
4+
- [ ] written relevant docs (or none needed)
5+
- [ ] referenced any relevant issues (or none exist)
6+
7+
### Guidelines
8+
9+
Please add a description of this Pull Request's motivation, scope, outstanding issues or potential alternatives, reasoning behind the current solution, and any other relevant information for posterity.
10+
11+
---
12+
13+
*Your PR Notes Here*

0 commit comments

Comments
 (0)