Skip to content

Commit

Permalink
chore: add github issues template
Browse files Browse the repository at this point in the history
  • Loading branch information
heliomarpm committed Aug 22, 2023
1 parent 4118bc9 commit daf1441
Show file tree
Hide file tree
Showing 7 changed files with 268 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
github: heliomarpm

ko_fi: heliomarpm
liberapay: heliomarpm
custom: [
"https://www.paypal.com/donate?business=KBVHLR7Z9V7B2&no_recurring=0&currency_code=USD",
"https://www.paypal.com/donate?business=KBVHLR7Z9V7B2&no_recurring=0&currency_code=BRL"
]
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: '🐛 Bug Report'
description: Report a reproducible bug.
labels:
- possible-bug
- needs-triage
body:
- type: markdown
attributes:
value: 'Please read and follow the instructions before submitting an issue:'
- type: markdown
attributes:
value: |
- Read all our documentation, especially the [README](https://github.com/heliomarpm/keyvalues-storage/blob/master/README.md). It may contain information that helps you solve your issue.
- Ensure your issue isn't already [reported](https://github.com/heliomarpm/keyvalues-storage/issues?utf8=%E2%9C%93&q=is%3Aissue).
- Ensure it isn't already fixed in the latest KVS version.
- type: markdown
attributes:
value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
- type: textarea
id: description
attributes:
label: 'Describe the bug'
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: 'To Reproduce'
description: |
Code snippet to reproduce, ideally if you can provide a live example in https://codesandbox.io/ sandbox or a repository that illustrates the issue.
**If your problem is not reproducible, please file under Support or Usage Question**
validations:
required: false
- type: textarea
id: code-snippet
attributes:
label: 'Code snippet'
render: js
validations:
required: false
- type: textarea
id: expected
attributes:
label: 'Expected behavior'
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: markdown
attributes:
value: Environment

- type: input
id: node-version
attributes:
label: 'Node.js Version'
description: 'node --version'
placeholder: 'e.g. 13.0.1'
- type: input
id: os
attributes:
label: 'OS'
placeholder: 'e.g. iOS 16.0.2, OSX 12.6.0'
- type: textarea
id: other-version
attributes:
label: 'Additional Library Versions'
placeholder: |
e.g.
React 16.7,
React Native 0.58.0
render: bash
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: 'Additional context/Screenshots'
description: Add any other context about the problem here. If applicable, add screenshots to help explain.
render: bash
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: "😎 Heliomar P. Marques"
url: https://navto.me/heliomarpm
about: Abaout Me
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: '📝 Documentation'
description: Report an error or area that needs clarification.
labels:
- documentation
- needs-triage
body:
- type: markdown
attributes:
value: 'If you found an area that needs clarification, feel free to open a PR or list the section/content that could be improved below'
- type: markdown
attributes:
value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
- type: textarea
id: content
attributes:
label: 'Section/Content To Improve'
description: Quote or link to section
validations:
required: true
- type: textarea
id: solution
attributes:
label: 'Suggested Improvement'
description: Identify what is confusing or incorrect and what could make it better
validations:
required: true
- type: textarea
id: files
attributes:
label: 'Relevant File(s)'
placeholder: e.g. README.md
render: bash
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: '✨ Feature Request'
description: Suggest an idea or feature.
labels:
- enhancement
- needs-triage
body:
- type: markdown
attributes:
value: 'Please read and follow the instructions before submitting an issue:'
- type: markdown
attributes:
value: |
- Read all our documentation, especially the [README](https://github.com/heliomarpm/keyvalues-storage/blob/master/README.md). It may contain information that helps you solve your issue.
- Ensure your issue isn't already [reported](https://github.com/heliomarpm/keyvalues-storage/issues?utf8=%E2%9C%93&q=is%3Aissue).
- type: markdown
attributes:
value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
- type: textarea
id: description
attributes:
label: 'Is your feature request related to a problem? Please describe.'
description: A clear and concise description of what the problem is.
placeholder: I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: false
- type: textarea
id: alternative
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: 'Additional context/Screenshots'
description: Add any other context or screenshots about the feature request here.
render: bash
validations:
required: false
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/support_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: '🤔 Support or Usage Question'
description: Get help using KVS.
labels:
- question
- needs-triage
body:
- type: markdown
attributes:
value: 'Please read and follow the instructions before submitting an issue:'
- type: markdown
attributes:
value: |
- Read all our documentation, especially the [README](https://github.com/heliomarpm/keyvalues-storage/blob/master/README.md). It may contain information that helps you solve your issue.
- Ensure your issue isn't already [reported](https://github.com/heliomarpm/keyvalues-storage/issues?utf8=%E2%9C%93&q=is%3Aissue).
- type: markdown
attributes:
value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
- type: textarea
id: description
attributes:
label: 'Describe the issue'
description: A clear and concise description of what the issue is.
validations:
required: true
- type: textarea
id: example
attributes:
label: 'Example Code'
description: Code snippet to illustrate your question
render: js
validations:
required: false
- type: textarea
id: expected
attributes:
label: 'Expected behavior'
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: markdown
attributes:
value: Environment

- type: input
id: node-version
attributes:
label: 'Node.js Version'
description: 'node --version'
placeholder: 'e.g. 16.8.1'
- type: input
id: os
attributes:
label: 'OS'
placeholder: 'e.g. iOS 16.0.2, OSX 12.6.0'
- type: textarea
id: other-version
attributes:
label: 'Additional Library Versions'
placeholder: |
e.g.
React 16.7,
React Native 0.58.0
render: bash
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: 'Additional context/Screenshots'
description: Add any other context about the problem here. If applicable, add screenshots to help explain.
render: bash
validations:
required: false
20 changes: 20 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Summary of the Pull Request
Thanks for contributing!

Please be sure you are following the guidelines at
https://github.com/heliomarpm/keyvalues-storage/blob/master/docs/CONTRIBUTING.md

**What is this about:**

**What is included in the PR:**

**How does someone test / validate:**

## Quality ChecklistV

- [ ] **Linked issue:** #xxx
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end user facing strings can be localized
- [ ] **Docs:** Added/ updated
<!-- - [ ] **Communication:** I've discussed this with core contributors in the issue. -->
<!-- - [ ] **Installer:** Added/updated and all pass -->

0 comments on commit daf1441

Please sign in to comment.