mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 08:38:32 +02:00
Clean up templates and issues (#954)
* clean up templates and issues * fix some title-casing
This commit is contained in:
Jonathan Wren
GitHub
parent
a4d020423f
commit
e37fe2e4ce
5 changed files with 100 additions and 57 deletions
40
.github/ISSUE_TEMPLATE/bug_report.md
vendored
40
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -7,20 +7,36 @@ assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Bug report
|
## Bug Report
|
||||||
|
<!--
|
||||||
|
Hello, and thank you for reporting an issue!
|
||||||
|
Please fill out the points below, as it will make our process much easier.
|
||||||
|
-->
|
||||||
|
|
||||||
Hello! Thank you for reporting an issue!
|
<!-- Please tell us about your environment -->
|
||||||
If you would fill out the below points, that would make our process a whole lot easier!
|
### Environment
|
||||||
|
- Jrnl version: <!-- Run `jrnl -v` -->
|
||||||
|
- Install method: <!-- How did you install jrnl? (pipx, brew, etc) -->
|
||||||
|
- OS <!-- What is your operating system? (MacOS, Linux, Windows) -->
|
||||||
|
|
||||||
* **Please tell us about your environment:**
|
### Current Behavior
|
||||||
- Jrnl version: (run `jrnl -v`)
|
<!--
|
||||||
- How you installed Jrnl
|
Please put a short description of what is currently happening.
|
||||||
- Operating system [MacOS, Linux, Windows?]
|
-->
|
||||||
|
|
||||||
* **What is the current behavior?**
|
### Expected Behavior
|
||||||
|
<!--
|
||||||
|
Please write a short description of what you would expect to happen
|
||||||
|
(instead of what is currently happening).
|
||||||
|
-->
|
||||||
|
|
||||||
* **Please provide the steps to reproduce and if possible a minimal demo of the problem**
|
### Repro Steps
|
||||||
|
<!--
|
||||||
|
Please provide the steps to reproduce the problem. It is important for you to
|
||||||
|
be as precise as possible here, since more info will let us help you faster.
|
||||||
|
-->
|
||||||
|
|
||||||
* **What is the expected behavior?**
|
### Other Information
|
||||||
|
<!-- (e.g. more detailed explanation, stacktraces, related
|
||||||
* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
|
issues, suggestions how to fix, links for us to have context, eg.
|
||||||
|
stackoverflow, gitter, etc) -->
|
||||||
|
|
|
||||||
24
.github/ISSUE_TEMPLATE/feature_request.md
vendored
24
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -8,12 +8,24 @@ assignees: ''
|
||||||
---
|
---
|
||||||
|
|
||||||
## Feature Request
|
## Feature Request
|
||||||
|
<!--
|
||||||
|
Hello, and thank you for reporting an issue!
|
||||||
|
Please fill out the points below, as it will make our process much easier.
|
||||||
|
-->
|
||||||
|
|
||||||
Hello! Thank you for reporting an issue!
|
### Use Case/Motivation
|
||||||
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?
|
||||||
|
-->
|
||||||
|
|
||||||
* **What is the motivation / use case for changing the behavior?**
|
### Example Usage
|
||||||
|
<!--
|
||||||
|
Please provide examples of the usage you would like to see.
|
||||||
|
e.g `jrnl --new-flag="super cool new feature"`
|
||||||
|
-->
|
||||||
|
|
||||||
* **Please provide examples of the usage**
|
### Other information
|
||||||
|
<!--
|
||||||
* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
|
Please provide any other relevant info about this request (e.g. stacktraces,
|
||||||
|
related issues, suggestions how to fix, etc)
|
||||||
|
-->
|
||||||
|
|
|
||||||
39
.github/ISSUE_TEMPLATE/support_request.md
vendored
39
.github/ISSUE_TEMPLATE/support_request.md
vendored
|
|
@ -7,20 +7,33 @@ assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Support request
|
## Support Request
|
||||||
|
<!--
|
||||||
|
Hello, and thank you for reporting an issue!
|
||||||
|
Please fill out the points below, as it will make our process much easier.
|
||||||
|
-->
|
||||||
|
|
||||||
Hello! Thank you for reporting an issue!
|
### Environment
|
||||||
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` -->
|
||||||
|
- Install method: <!-- How did you install jrnl? (pipx, brew, etc) -->
|
||||||
|
- OS <!-- What is your operating system? (MacOS, Linux, Windows) -->
|
||||||
|
|
||||||
* **Please tell us about your environment:**
|
### What are you trying to do?
|
||||||
|
<!--
|
||||||
|
Please write a short description of what is happening.
|
||||||
|
-->
|
||||||
|
|
||||||
- Jrnl version: (run `jrnl -v`)
|
### What have you tried?
|
||||||
- How you installed Jrnl
|
<!--
|
||||||
|
Have you tried anything to fix the problem? This can help give us more
|
||||||
|
information to help you with.
|
||||||
|
-->
|
||||||
|
|
||||||
- Operating system [MacOS, Linux, Windows?]
|
### Other Information
|
||||||
|
<!--
|
||||||
* **What are you trying to do?**
|
Is there anything else we should know that might be helpful?
|
||||||
|
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix
|
||||||
* **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)
|
|
||||||
|
|
|
||||||
46
.github/PULL_REQUEST_TEMPLATE.md
vendored
46
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,32 +1,26 @@
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
# **TEMPLATE PLEASE EDIT**
|
Thank you for wanting to contribute!
|
||||||
*Thank you for wanting to contribute! Please fill out this description as well
|
|
||||||
as look at the checklist!*
|
|
||||||
|
|
||||||
*Short block of text containing:
|
Please fill out this description, and the checklist below.
|
||||||
- Relevant changes in text form
|
|
||||||
- related issues
|
Here are some key points to include in your description:
|
||||||
- Motivation (if applicable)
|
- What is this new code intended to do?
|
||||||
- Example of usage (if applicable)
|
- Are there any related issues?
|
||||||
- Example of changes to config files (if applicable)
|
- What is the motivation for this change?
|
||||||
*
|
- What is an example of usage, or changes to config files? (if applicable)
|
||||||
-->
|
-->
|
||||||
|
|
||||||
### Checklist
|
### Checklist
|
||||||
|
|
||||||
- [ ] The code change is tested and works locally.
|
- [ ] I have read the [contributing doc](https://github.com/jrnl-org/jrnl/blob/develop/CONTRIBUTING.md).
|
||||||
- [ ] Tests pass. Your PR cannot be merged unless tests pass. --
|
- [ ] I have included a link to the relevant issue number.
|
||||||
`poetry run behave`
|
- [ ] I have tested this code locally.
|
||||||
- [ ] The code passes linting via
|
- [ ] I have checked to ensure there aren't other open [pull requests](../pulls)
|
||||||
[black](https://black.readthedocs.io/en/stable/) (consistent code styling). --
|
for the same issue.
|
||||||
`poetry run black --check . --verbose --diff`
|
- [ ] I have you written new tests for these changes, as needed.
|
||||||
- [ ] The code passes linting via [pyflakes](https://launchpad.net/pyflakes)
|
- [ ] All tests pass.
|
||||||
(logically errors and unused imports). -- `poetry run pyflakes jrnl features`
|
<!--
|
||||||
- [ ] There is no commented out code in this PR.
|
NOTE: Your PR may not be reviewed if there are any failing tests. You can run
|
||||||
- [ ] Have you followed the guidelines in our Contributing document?
|
tests locally with `make test` (see the contributing doc if you need help with
|
||||||
- [ ] Have you checked to ensure there aren't other open
|
`make`), or use our automated tests after you submit your PR.
|
||||||
[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?
|
|
||||||
|
|
|
||||||
8
issue_template.md
Normal file
8
issue_template.md
Normal file
|
|
@ -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
|
||||||
Loading…
Add table
Reference in a new issue