Add issue and PR templates (#455)

Co-authored-by: Tatiana Mac <github@tatianamac.com>
This commit is contained in:
Kurt Kemple 2022-05-20 13:25:21 -04:00 committed by GitHub
parent 2b51e9353a
commit cc2f0c25f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 217 additions and 1 deletions

61
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@ -0,0 +1,61 @@
name: Bug Report
description: File a bug report
title: ":bug: "
labels: ["Type · Bug", "Status · Unconfirmed"]
body:
- type: markdown
attributes:
value: |
We appreciate you taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What issue are you facing?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expenced behavior
description: Tell us what you expected to see
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: Browsers
description: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Brave
- Other
- type: input
id: other-browser
attributes:
label: Other browser
description: What browser did you experience the issue in?
- type: input
id: device
attributes:
label: Device
description: Was this issue on a mobile device? If so, what one?
- type: textarea
id: logs
attributes:
label: Relevant log (or console) output
description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for backticks!
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/selfdefined/web-app/blob/prod/CODE-OF-CONDUCT.md)
options:
- label: I agree to follow Self-Defined's Code of Conduct
required: true

2
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,2 @@
# prevent blank issue
blank_issues_enabled: false

32
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@ -0,0 +1,32 @@
name: Feature Request
description: File a feature request
title: ":ballot_box: "
body:
- type: markdown
attributes:
value: |
We appreciate you taking the time to fill out this feature request!
- type: textarea
id: request
attributes:
label: Request
description: What is it that seems to be missing or could be improved?
validations:
required: true
- type: checkboxes
id: existing
attributes:
label: Is this a new feature or a suggested update?
description: This helps us properly label issues and move them along the right workflows.
options:
- label: Existing feature
- label: New feature
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/selfdefined/web-app/blob/prod/CODE-OF-CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

44
.github/ISSUE_TEMPLATE/suggestion.yml vendored Normal file
View File

@ -0,0 +1,44 @@
name: Word Suggestion
description: Share a word suggestion
title: ":blue_book: "
labels: ["Type · Definitions", "Status · Unconfirmed"]
body:
- type: markdown
attributes:
value: |
We appreciate you taking the time to fill out word definition request!
- type: input
id: word
attributes:
label: What word would you like to see defined?
description: What word do you think need to be in the Self-Defined dictionary and why?
validations:
required: true
- type: textarea
id: related-resources
attributes:
label: Please share any relevant links to articles, books, podcasts, videos, etc. We prefer when speaking about a group that the writer identifies as part of that group.
description: Please provide at least one related example or definition.
validations:
required: true
- type: textarea
id: definition
attributes:
label: If you already have a definition in mind, share it here
description: If you have an idea about what the definition should be, please share it here.
render: shell
- type: checkboxes
id: assign-to-me
attributes:
label: Would you like to lead/steward defining this word?
description: By checking this, you'll be assigned this issue and we'll work with you to get the definition added should it be accepted!
options:
- label: Yeah, assign it to me!
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/selfdefined/web-app/blob/prod/CODE-OF-CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

42
.github/ISSUE_TEMPLATE/translation.yml vendored Normal file
View File

@ -0,0 +1,42 @@
name: Translation
description: Request a translation
title: ":globe_with_meridians: "
body:
- type: markdown
attributes:
value: |
We appreciate you taking the time to fill out this translation request!
- type: input
id: word
attributes:
label: What word do you want to translate (or see translated)?
validations:
required: true
- type: input
id: language
attributes:
label: What langauge would you like to this definition translated to?
validations:
required: true
- type: checkboxes
id: assign-to-me
attributes:
label: Would you like to lead translating this word?
description: By checking this, you'll be assigned this issue and we'll work with you to get the definition added should it be accepted!
options:
- label: Yeah, assign it to me!
- type: checkboxes
id: have-reviewer
attributes:
label: Do you have any fluent colleagues who could review your translations?
description: Translations will always be shared with our community to review, but we recognise that many languages are not yet widely represented. We always want to ensure all entries are peer-reviewed by as many folks as possible.
options:
- label: Yeah, I'll have someone review it!
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/selfdefined/web-app/blob/prod/CODE-OF-CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

34
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,34 @@
<!--- Provide a general summary of your changes in the Title above -->
## Description
<!--- Describe your changes in detail -->
## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->
## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
## Screenshots (if appropriate):
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] I have read the **CONTRIBUTING** document.
- [ ] My code follows the code style of this project.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

3
.gitignore vendored
View File

@ -3,4 +3,5 @@ node_modules
dist dist
config.codekit3 config.codekit3
.cache .cache
.sass-cache .sass-cache
.vscode