-
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add issue and pull-request templates
extend contributing guidelines closes #41
- Loading branch information
Showing
6 changed files
with
118 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
name: Bug Report | ||
description: Report a bug in Ocular | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: I've found a bug and checked that ... | ||
description: Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why. | ||
options: | ||
- label: ...there are no open or closed issues that are related to my problem | ||
- label: ...it's definitely a bug and not a feature request | ||
|
||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: Please provide a brief description of the bug in 1-2 sentences. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Environment | ||
description: Please provide information about your environment. | ||
placeholder: | | ||
- Browser: [e.g. Chrome, Safari] | ||
- OS: [e.g. Windows, macOS] | ||
- Version: [e.g. 22] | ||
- Ocular version: [e.g. 1.4] | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Expected behaviour | ||
description: Please describe precisely what you'd expect to happen. Be specific. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: Steps to reproduce | ||
description: Please describe the steps to reproduce the bug. | ||
placeholder: | | ||
1. ... | ||
2. ... | ||
3. ... | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional info | ||
description: Please provide any additional information that seem useful. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Ask a question | ||
url: https://github.com/simonwep/ocular/discussions | ||
about: Please ask and answer questions here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: Feature Request | ||
description: Request a feature or enhancement in Ocular | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Support guidelines | ||
description: Please make sure that your request fulfills all of the following requirements. If you still want to proceed, explain in detail why. | ||
options: | ||
- label: My request extends the functionality of Ocular in a meaningful way. | ||
required: true | ||
- label: I've used [the search](https://github.com/firefly-iii/firefly-iii/issues?q=is%3Aissue) and this has not been requested before. | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: Please describe your feature request | ||
placeholder: | | ||
- I would like Ocular to do (thing). | ||
- What if you would add feature (feature here)? | ||
- Ocular doesn't do (thing). | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Solution | ||
description: Describe what your feature would add to Ocular. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: What are alternatives? | ||
description: Please describe what alternatives currently exist. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
## Summary | ||
<!-- Provide a general summary of your changes in the Title above --> | ||
|
||
|
||
## I made sure that: | ||
<!-- Check the following items --> | ||
|
||
- [ ] I have read the [contributing guidelines](./CONTRIBUTING.md). | ||
- [ ] I have searched for a similar pull request. | ||
- [ ] The feature/bug-fix is tested carefully. | ||
- [ ] All irrelevant commits are squashed. (e.g. no `chore: fix eslint` commits). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters