diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 02c0c251..d93d1422 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,20 +7,36 @@ assignees: '' --- -## Bug report +## 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! + +### Environment + - Jrnl version: + - Install method: + - OS -* **Please tell us about your environment:** - - Jrnl version: (run `jrnl -v`) - - How you installed Jrnl - - Operating system [MacOS, Linux, Windows?] +### Current Behavior + -* **What is the current behavior?** +### Expected Behavior + -* **Please provide the steps to reproduce and if possible a minimal demo of the problem** +### Repro Steps + -* **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) +### Other Information + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 8690ad71..d9061604 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,12 +8,24 @@ assignees: '' --- ## 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! +### Use Case/Motivation + -* **What is the motivation / use case for changing the behavior?** +### Example Usage + -* **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) +### Other information + diff --git a/.github/ISSUE_TEMPLATE/support_request.md b/.github/ISSUE_TEMPLATE/support_request.md index d9608885..04c2a217 100644 --- a/.github/ISSUE_TEMPLATE/support_request.md +++ b/.github/ISSUE_TEMPLATE/support_request.md @@ -7,20 +7,33 @@ assignees: '' --- -## Support request +## 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! +### Environment + + - Jrnl version: + - Install method: + - OS -* **Please tell us about your environment:** +### What are you trying to do? + - - Jrnl version: (run `jrnl -v`) - - How you installed Jrnl +### What have you tried? + - - 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) +### Other Information + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 49533409..cea2848c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,32 +1,26 @@ - ### Checklist -- [ ] The code change is tested and works locally. -- [ ] Tests pass. Your PR cannot be merged unless tests pass. -- - `poetry run behave` -- [ ] The code passes linting via - [black](https://black.readthedocs.io/en/stable/) (consistent code styling). -- - `poetry run black --check . --verbose --diff` -- [ ] The code passes linting via [pyflakes](https://launchpad.net/pyflakes) - (logically errors and unused imports). -- `poetry run pyflakes jrnl features` -- [ ] 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? +- [ ] I have read the [contributing doc](https://github.com/jrnl-org/jrnl/blob/develop/CONTRIBUTING.md). +- [ ] I have included a link to the relevant issue number. +- [ ] I have tested this code locally. +- [ ] I have checked to ensure there aren't other open [pull requests](../pulls) + for the same issue. +- [ ] I have you written new tests for these changes, as needed. +- [ ] All tests pass. + diff --git a/issue_template.md b/issue_template.md new file mode 100644 index 00000000..7f2c21d6 --- /dev/null +++ b/issue_template.md @@ -0,0 +1,8 @@ +# Stop + +Please don't file a blank issue. + +Fill out one of the templates from the link below and we'll be better able to +help you. + +https://github.com/jrnl-org/jrnl/issues/new/choose