diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..8e15459 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,23 @@ +Questions +---------- + +If you have any questions regarding the project, how something was implemented, or why something was done a certain way, feel free to ask! Please make sure to prefix your title with `Question - ` for this issue. + +Reporting a Bug +---------------- + +If you've found a bug somewhere in the code or project, please make sure to prefix your title with `Bug - ` for this issue. Make sure to include: + + - Description of the bug. + - Where you've found it. + - Any suggestions on fixing it (if applicable & you have any suggestions in mind). + +Suggesting a Feature +--------------------- + +If you'd like to suggest a new feature or improvement to the project, please make sure to prefix your title with `Request - ` for this issue. Make sure to include + + - Why this feature would be beneficial for this project. + - Any suggestions on how to implement this feature (if applicable & you have any suggestions in mind). + +Thank you! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..21f6af3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,6 @@ +Thanks for submitting a pull request! There are a few things to add that'd really help triaging this PR: + + - If its fixing a bug, please prefix the title with `Bugfix - ` and try to add `Closes #[issue number]` if there is an open issue about the bug. + - If its implementing a feature, please prefix the title with `Feature - ` and try to add `Closes #[issue number]` if there is an open issue about the feature request. + +Thank you!