diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..8ca44464 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,35 @@ +Hello! Thank you for reporting an issue! +If you would fill out the below points, that would make our process a whole lot easier! + +## **I'm submitting a ...** + - [ ] bug report + - [ ] feature request + - [ ] support request + + + + +## Regarding bug reports: + +* **Please tell us about your environment:** + - Jrnl version: (run `jrnl -v`) + - How you installed Jrnl + + - Operating system [MacOS, Linux, Windows?] + +* **What is the current behavior?** + +* **Please provide the steps to reproduce and if possible a minimal demo of the problem** + + +* **What is the expected behavior?** + +* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) + +## Regarding Feature requests: + +* **What is the motivation / use case for changing the behavior?** + +* **Please provide examples of the usage** + +* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 00000000..38cf527e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,20 @@ +## Bug report +Hello! Thank you for reporting an issue! +If you would fill out the below points, that would make our process a whole lot easier! + + +* **Please tell us about your environment:** + - Jrnl version: (run `jrnl -v`) + - How you installed Jrnl + + - Operating system [MacOS, Linux, Windows?] + +* **What is the current behavior?** + +* **Please provide the steps to reproduce and if possible a minimal demo of the problem** + + +* **What is the expected behavior?** + +* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) + diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 00000000..f9357f42 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,9 @@ +#Feature Request +Hello! Thank you for reporting an issue! +If you would fill out the below points, that would make our process a whole lot easier! + +* **What is the motivation / use case for changing the behavior?** + +* **Please provide examples of the usage** + +* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) diff --git a/.github/ISSUE_TEMPLATE/Support_request.md b/.github/ISSUE_TEMPLATE/Support_request.md new file mode 100644 index 00000000..814d1f70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Support_request.md @@ -0,0 +1,19 @@ +## Support request +Hello! Thank you for reporting an issue! +If you would fill out the below points, that would make our process a whole lot easier! + + + +* **Please tell us about your environment:** + + - Jrnl version: (run `jrnl -v`) + - How you installed Jrnl + + - Operating system [MacOS, Linux, Windows?] + +* **What are you trying to do?** + +* **What have you tried?** + +* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..986f10ee --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,19 @@ + +# **TEMPLATE PLEASE EDIT** +*Thank you for wanting to contribute! Please fill out this description as well as look at the checklist!* + +*Short block of text containing: +- Relevant changes in text form +- related issues +- Motivation (if applicable) +- Example of usage (if applicable) +- Example of changes to config files (if applicable) +* +### Checklist +- [ ] The code change is tested and works locally. +- [ ] Tests pass. Your PR cannot be merged unless tests pass +- [ ] There is no commented out code in this PR. +- [ ] Have you followed the guidelines in our Contributing document? +- [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change? +- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? +- [ ] Have you written new tests for your core changes, as applicable?