Skip to content

Commit cc2f0c2

Browse files
kkempletatianamac
andauthored
Add issue and PR templates (#455)
Co-authored-by: Tatiana Mac <github@tatianamac.com>
1 parent 2b51e93 commit cc2f0c2

File tree

7 files changed

+217
-1
lines changed

7 files changed

+217
-1
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: ":bug: "
4+
labels: ["Type · Bug", "Status · Unconfirmed"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We appreciate you taking the time to fill out this bug report!
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: What issue are you facing?
15+
placeholder: Tell us what you see!
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: expected-behavior
20+
attributes:
21+
label: Expenced behavior
22+
description: Tell us what you expected to see
23+
validations:
24+
required: true
25+
- type: dropdown
26+
id: browsers
27+
attributes:
28+
label: Browsers
29+
description: What browsers are you seeing the problem on?
30+
multiple: true
31+
options:
32+
- Firefox
33+
- Chrome
34+
- Safari
35+
- Microsoft Edge
36+
- Brave
37+
- Other
38+
- type: input
39+
id: other-browser
40+
attributes:
41+
label: Other browser
42+
description: What browser did you experience the issue in?
43+
- type: input
44+
id: device
45+
attributes:
46+
label: Device
47+
description: Was this issue on a mobile device? If so, what one?
48+
- type: textarea
49+
id: logs
50+
attributes:
51+
label: Relevant log (or console) output
52+
description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for backticks!
53+
render: shell
54+
- type: checkboxes
55+
id: terms
56+
attributes:
57+
label: Code of Conduct
58+
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)
59+
options:
60+
- label: I agree to follow Self-Defined's Code of Conduct
61+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# prevent blank issue
2+
blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature Request
2+
description: File a feature request
3+
title: ":ballot_box: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
We appreciate you taking the time to fill out this feature request!
9+
- type: textarea
10+
id: request
11+
attributes:
12+
label: Request
13+
description: What is it that seems to be missing or could be improved?
14+
validations:
15+
required: true
16+
- type: checkboxes
17+
id: existing
18+
attributes:
19+
label: Is this a new feature or a suggested update?
20+
description: This helps us properly label issues and move them along the right workflows.
21+
options:
22+
- label: Existing feature
23+
- label: New feature
24+
required: true
25+
- type: checkboxes
26+
id: terms
27+
attributes:
28+
label: Code of Conduct
29+
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)
30+
options:
31+
- label: I agree to follow this project's Code of Conduct
32+
required: true

.github/ISSUE_TEMPLATE/suggestion.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Word Suggestion
2+
description: Share a word suggestion
3+
title: ":blue_book: "
4+
labels: ["Type · Definitions", "Status · Unconfirmed"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We appreciate you taking the time to fill out word definition request!
10+
- type: input
11+
id: word
12+
attributes:
13+
label: What word would you like to see defined?
14+
description: What word do you think need to be in the Self-Defined dictionary and why?
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: related-resources
19+
attributes:
20+
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.
21+
description: Please provide at least one related example or definition.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: definition
26+
attributes:
27+
label: If you already have a definition in mind, share it here
28+
description: If you have an idea about what the definition should be, please share it here.
29+
render: shell
30+
- type: checkboxes
31+
id: assign-to-me
32+
attributes:
33+
label: Would you like to lead/steward defining this word?
34+
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!
35+
options:
36+
- label: Yeah, assign it to me!
37+
- type: checkboxes
38+
id: terms
39+
attributes:
40+
label: Code of Conduct
41+
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)
42+
options:
43+
- label: I agree to follow this project's Code of Conduct
44+
required: true
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Translation
2+
description: Request a translation
3+
title: ":globe_with_meridians: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
We appreciate you taking the time to fill out this translation request!
9+
- type: input
10+
id: word
11+
attributes:
12+
label: What word do you want to translate (or see translated)?
13+
validations:
14+
required: true
15+
- type: input
16+
id: language
17+
attributes:
18+
label: What langauge would you like to this definition translated to?
19+
validations:
20+
required: true
21+
- type: checkboxes
22+
id: assign-to-me
23+
attributes:
24+
label: Would you like to lead translating this word?
25+
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!
26+
options:
27+
- label: Yeah, assign it to me!
28+
- type: checkboxes
29+
id: have-reviewer
30+
attributes:
31+
label: Do you have any fluent colleagues who could review your translations?
32+
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.
33+
options:
34+
- label: Yeah, I'll have someone review it!
35+
- type: checkboxes
36+
id: terms
37+
attributes:
38+
label: Code of Conduct
39+
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)
40+
options:
41+
- label: I agree to follow this project's Code of Conduct
42+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Related Issue
7+
<!--- This project only accepts pull requests related to open issues -->
8+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
9+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
10+
<!--- Please link to the issue here: -->
11+
12+
## Motivation and Context
13+
<!--- Why is this change required? What problem does it solve? -->
14+
15+
## How Has This Been Tested?
16+
<!--- Please describe in detail how you tested your changes. -->
17+
<!--- Include details of your testing environment, and the tests you ran to -->
18+
<!--- see how your change affects other areas of the code, etc. -->
19+
20+
## Screenshots (if appropriate):
21+
22+
## Types of changes
23+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
24+
- [ ] Bug fix (non-breaking change which fixes an issue)
25+
- [ ] New feature (non-breaking change which adds functionality)
26+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
27+
28+
## Checklist:
29+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
30+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
31+
- [ ] I have read the **CONTRIBUTING** document.
32+
- [ ] My code follows the code style of this project.
33+
- [ ] I have added tests to cover my changes.
34+
- [ ] All new and existing tests passed.

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ node_modules
33
dist
44
config.codekit3
55
.cache
6-
.sass-cache
6+
.sass-cache
7+
.vscode

0 commit comments

Comments
 (0)