Skip to content

Commit 2b112b0

Browse files
cmaclaughlincmaclaughlin
authored
Issue and PR templates (#37)
* update gitignore Signed-off-by: GitHub <[email protected]> * Explicitly include existing tfvars Signed-off-by: Cara MacLaughlin <[email protected]> * Update PR template Signed-off-by: Cara MacLaughlin <[email protected]> * Bug template Signed-off-by: Cara MacLaughlin <[email protected]> * Task template Signed-off-by: Cara MacLaughlin <[email protected]> * Feature template Signed-off-by: Cara MacLaughlin <[email protected]> * Config and filename cleanup Signed-off-by: Cara MacLaughlin <[email protected]> --------- Signed-off-by: GitHub <[email protected]> Signed-off-by: Cara MacLaughlin <[email protected]>
1 parent 912d752 commit 2b112b0

File tree

7 files changed

+156
-81
lines changed

7 files changed

+156
-81
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/01-bug.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Bug
2+
description: Report a bug
3+
title: "[Bug] <title>"
4+
type: Bug
5+
body:
6+
- type: checkboxes
7+
id: existing
8+
attributes:
9+
label: Is there an existing issue?
10+
description: Please search to see if the issue has already been reported.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: description
16+
attributes:
17+
label: Description
18+
description: Describe the bug in detail.
19+
placeholder: |
20+
A clear and concise description of what the bug is.
21+
- type: textarea
22+
id: steps
23+
attributes:
24+
label: Steps to Reproduce
25+
description: Steps to reproduce the behavior.
26+
placeholder: |
27+
1. In this environment
28+
2. With this configuration
29+
3. Run this command
30+
4. See error
31+
render: markdown
32+
validation:
33+
required: false
34+
- type: textarea
35+
id: expected
36+
attributes:
37+
label: Expected Behavior
38+
description: Describe what you expected to happen.
39+
placeholder: |
40+
A clear and concise description of what you expected to happen.
41+
validation:
42+
required: true
43+
- type: textarea
44+
id: additional
45+
attributes:
46+
label: Anything else?
47+
description: |
48+
Add any other context about the problem here.
49+
If applicable, add screenshots to help explain your problem.
50+
validation:
51+
required: false

‎.github/ISSUE_TEMPLATE/02-feature.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Feature
2+
type: Feature
3+
description: Define a feature
4+
title: "[Feature] <title>"
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Describe the feature in detail.
11+
placeholder: |
12+
A clear and concise description of what the feature is.
13+
validation:
14+
required: true
15+
- type: textarea
16+
id: story
17+
attributes:
18+
label: User Story
19+
description: Describe the user story.
20+
placeholder: |
21+
As a <type of user>, I want <some goal> so that <some reason>.
22+
validation:
23+
required: false
24+
- type: textarea
25+
id: done
26+
attributes:
27+
label: Definition of Done
28+
description: Describe what "done" looks like for this feature.
29+
placeholder: |
30+
- Acceptance criteria
31+
- Tests
32+
- Documentation
33+
render: markdown
34+
validation:
35+
required: true
36+
- type: textarea
37+
id: value
38+
attributes:
39+
label: Values Provided
40+
description: |
41+
Value provided by this feature.
42+
validation:
43+
required: false
44+
- type: textarea
45+
id: additional
46+
attributes:
47+
label: Additional Information
48+
description: |
49+
Any additional information that is relevant to this feature.
50+
validation:
51+
required: false
52+
- type: markdown
53+
id: subtasks
54+
attributes:
55+
value: |
56+
**Please use the "sub-issues" feature to create tasks for this feature.**
57+
You can create sub-issues by clicking on the "Create sub-issue" button in the sidebar.
58+
This will create a new issue that is linked to this feature.
59+
You can also use the "Linked issues" feature to link existing issues to this feature.
60+
This will help us track the progress of the feature and ensure that all tasks are completed.

‎.github/ISSUE_TEMPLATE/03-task.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Task
2+
description: Define a task
3+
title: "[Task] <title>"
4+
type: Task
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Describe the task in detail.
11+
placeholder: |
12+
A clear and concise description of what the task is.
13+
validation:
14+
required: true
15+
- type: textarea
16+
id: done
17+
attributes:
18+
label: Definition of Done
19+
description: Describe what "done" looks like for this task.
20+
placeholder: |
21+
- Acceptance criteria
22+
- Tests
23+
- Documentation
24+
render: markdown
25+
validation:
26+
required: true
27+
- type: textarea
28+
id: value
29+
attributes:
30+
label: Values Provided
31+
description: |
32+
Value provided by this task.
33+
validation:
34+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 5 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,9 @@
1-
## Purpose
2-
<!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? -->
3-
* ...
1+
## Description
42

5-
## Does this introduce a breaking change?
6-
<!-- Mark one with an "x". -->
7-
```
8-
[ ] Yes
9-
[ ] No
10-
```
3+
Please include a summary of the changes.
114

12-
## Pull Request Type
13-
What kind of change does this Pull Request introduce?
5+
## Related Issue(s)
146

15-
<!-- Please check the one that applies to this PR using "x". -->
16-
```
17-
[ ] Bugfix
18-
[ ] Feature
19-
[ ] Code style update (formatting, local variables)
20-
[ ] Refactoring (no functional changes, no api changes)
21-
[ ] Documentation content changes
22-
[ ] Other... Please describe:
23-
```
7+
Link to the issue(s) this PR is related to. Prefix with "Fixes" or "Resolves". **Every PR must be associated with an Issue**
248

25-
## How to Test
26-
* Get the code
27-
28-
```
29-
git clone [repo-address]
30-
cd [repo-name]
31-
git checkout [branch-name]
32-
npm install
33-
```
34-
35-
* Test the code
36-
<!-- Add steps to run the tests suite and/or manually test -->
37-
```
38-
```
39-
40-
## What to Check
41-
Verify that the following are valid
42-
* ...
43-
44-
## Other Information
45-
<!-- Add any other helpful information that may be needed here. -->
9+
_Example: Resolves #1234_

‎.gitignore‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -414,9 +414,9 @@ crash.*.log
414414
# password, private keys, and other secrets. These should not be part of version
415415
# control as they are data points which are potentially sensitive and subject
416416
# to change depending on the environment.
417-
418-
*.tfvars
419-
*.tfvars.json
417+
**/*.tfvars
418+
**/*.tfvars.json
419+
!infra/main.tfvars.json
420420

421421
# Ignore override files as they are usually used to override resources locally and so
422422
# are not checked in
@@ -430,15 +430,13 @@ override.tf.json
430430
.terraform.lock.hcl
431431

432432
# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
433-
# example: *tfplan*
433+
*tfplan*
434+
*.tfplan
434435

435436
# Ignore CLI configuration files
436437
.terraformrc
437438
terraform.rc
438439

439-
# Plan files
440-
*.tfplan
441-
442440
# Test binaries and temporary files
443441
*.test
444442
*.out

0 commit comments

Comments
 (0)