Skip to content

Commit 7f7ba2a

Browse files
committed
Add templates for contribution and PR
1 parent 22bb948 commit 7f7ba2a

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Contributing:
2+
We welcome your involvement, be it fixing bugs or implementing new features that you find relevant to this library.
3+
4+
To contribute, you may follow the steps below:
5+
1. Fork the repo
6+
2. Create a new feature branch from `master` to work on your contribution
7+
3. Create a pull request back when you are done
8+
9+
Please refer to the ISSUES and PULL REQUEST templates when raising them. The reviewers will evaluate the request before merging into `master`
10+
11+
You can raise an issue within this Github repository to kick-start the discussion first.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue number)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
## How Has This Been Tested?
17+
18+
Please describe or list the test cases that you ran to verify your changes, and provide instructions so we can reproduce.
19+

0 commit comments

Comments
 (0)