Skip to content

Commit e4be332

Browse files
committed
Add extra information for contributors (#143)
This commit adds templates for pull requests and issues. The goal is to help those contributing to the project to get their issues handled quicker and their pull requests reviewed and merged quicker and more efficiently.
1 parent 4e2447a commit e4be332

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

Diff for: .github/ISSUE_TEMPLATE.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### Summary:
2+
3+
### Steps to reproduce:
4+
5+
1.
6+
2.
7+
3.
8+
9+
### Expected behavior:
10+
11+
### Additional notes:
12+

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Fixes #[issue number].
2+
3+
Changes proposed:
4+
-
5+
-
6+
-
7+
8+
Upgrade Path (for changed or removed APIs):
9+
10+
11+
Acceptance Checklist:
12+
[ ] All commits have been squashed to one.
13+
[ ] The commit message follows the guidlines in `CONTRIBUTING.md`.
14+
[ ] Documentation (README.md) and examples have been updated as needed.
15+
[ ] If this is a code change, a spec testing the functionality has been added.
16+
[ ] If the commit message has [changed] or [removed], there is an upgrade path above.

Diff for: CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ always be in sync.
2929
### Development
3030

3131
- `npm start` runs the dev server to run/develop examples
32-
- `npm test` will run the test.
32+
- `npm test` will run the tests.
3333
- `scripts/test` same as `npm test` but keeps karma running and watches
3434
for changes
3535

0 commit comments

Comments
 (0)