Skip to content

Commit

Permalink
clean up templates and issues
Browse files Browse the repository at this point in the history
  • Loading branch information
jrnl-bot committed May 17, 2020
1 parent cdaf1f5 commit 16af020
Show file tree
Hide file tree
Showing 5 changed files with 107 additions and 64 deletions.
48 changes: 32 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,35 @@ assignees: ''
---

## 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)
<!--
Hello, and thank you for reporting an issue!
Please fill out the points below, as it will make our process much easier.
-->

<!-- Please tell us about your environment -->
### 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) -->

### Current behavior
<!--
Please put a short description of what is currently happening.
-->

### Expected behavior
<!--
Please write a short description of what you would expect to happen
(instead of what is currently happening).
-->

### 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.
-->

### Other information
<!-- (e.g. more detailed explanation, stacktraces, related
issues, suggestions how to fix, links for us to have context, eg.
stackoverflow, gitter, etc) -->
24 changes: 18 additions & 6 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,24 @@ assignees: ''
---

## 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!
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?
-->

* **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** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
### Other information
<!--
Please provide any other relevant info about this request (e.g. stacktraces,
related issues, suggestions how to fix, etc)
-->
45 changes: 29 additions & 16 deletions .github/ISSUE_TEMPLATE/support_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,32 @@ assignees: ''
---

## 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)
<!--
Hello, and thank you for reporting an issue!
Please fill out the points below, as it will make our process much easier.
-->

### Environment
<!--
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) -->

### What are you trying to do?
<!--
Please write a short description of what is happening.
-->

### What have you tried?
<!--
Have you tried anything to fix the problem? This can help give us more
information to help you with.
-->

### Other information
<!--
Is there anything else we should know that might be helpful?
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix
-->
46 changes: 20 additions & 26 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,26 @@

<!--
# **TEMPLATE PLEASE EDIT**
*Thank you for wanting to contribute! Please fill out this description as well
as look at the checklist!*
Thank you for wanting to contribute!
Please fill out this description, and the checklist below.
*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)
*
Here are some key points to include in your description:
- What is this new code intended to do?
- Are there any related issues?
- What is the motivation for this change?
- What is an example of usage, or 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. --
`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.
<!--
NOTE: Your PR may not be reviewed if there are any failing tests. You can run
tests locally with `make test` (see the contributing doc if you need help with
`make`), or use our automated tests after you submit your PR.
-->
8 changes: 8 additions & 0 deletions issue_template.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 16af020

Please sign in to comment.