Skip to content

Commit 4f5d806

Browse files
Clarify contributor guidelines
1 parent b0b2f2f commit 4f5d806

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

.github/PULL_REQUEST_TEMPLATE

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Instructions
2+
- Open an issue to discuss what you want to do before submitting a PR
3+
- Your ideas are likely good, but may not be aware of the full context.
4+
- Why do work that might be a waste of your time if I disagree and decide not to merge it?
5+
- PRs should be merged into the `latestRelease` branch
6+
- allows me to continue working on `development` branch without needing to worry about merge conflicts until later
7+
- allows me to force-push to the `development` branch if need be without overwriting your commits
8+
9+
Once the above has been done, open a PR and delete this content.
10+
11+
Fixes: <issue number here>

CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributor Guidelines
2+
3+
- Before submitting a PR, open an issue to discuss what you want to do
4+
- Your ideas are likely good, but may not be aware of the full context.
5+
- Why do work that might be a waste of your time if I disagree and decide not to merge it?
6+
- PRs should be merged into the `latestRelease` branch
7+
- allows me to continue working on `development` branch without needing to worry about merge conflicts until later
8+
- allows me to force-push to the `development` branch if need be without overwriting your commits

0 commit comments

Comments
 (0)