Skip to content

Commit

Permalink
chore(root): add and update github issue and pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyFriesenGitHub committed Sep 9, 2024
1 parent 5e58fc2 commit 3de11e5
Show file tree
Hide file tree
Showing 18 changed files with 407 additions and 35 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/architectural-design-record--adr-.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Architectural Design Record (ADR)
about: Describe this issue template's purpose here.
title: "[ADR]"
labels: documentation, enhancement
about: Share your design record here
title: "[ADR]: "
labels: 'documentation'
assignees: ''

---
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: ''
title: "[BUG]: "
labels: 'bug'
assignees: ''

---
Expand Down
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Build
about: Suggest a change that would impact the build of the application
title: "build(scope-of-issue): description"
labels: 'dependencies'
assignees: ''

---

**What should we improve? What are we adding? Why do we need a new dependency? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here. **Include screenshots if needed**.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Task
about: Suggest an idea for this project
title: "[TASK]"
name: Chore
about: Suggest a task that can be implemented
title: "chore(scope-of-issue): description"
labels: ''
assignees: ''

Expand All @@ -14,4 +14,4 @@ A clear and concise description of what the problem is and your goal.
If there are no technical challenges, leave this blank.

**Additional context**
Add any other context or screenshots about the task.
Add any other context or screenshots about the task. **Include screenshots if needed**
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/ci.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Continuous Integration
about: Suggest a change to the current CI
title: "ci(scope-of-issue): description"
labels: ''
assignees: ''

---

**What should we improve? What are we fixing with the current pipeline? Why? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe any alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here. **Include screenshots if needed**.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Docs
about: Suggest a new addition to our documentation
title: "docs(scope-of-issue): description"
labels: 'documentation'
assignees: ''

---

**What should we improve? What are we adding? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe any alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here. **Include screenshots if needed**.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Feature Improvement
name: Feature
about: Suggest an idea for this project
title: "[FEAT. IMPROVEMENT]"
labels: ''
title: "feat(scope-of-issue): description"
labels: 'enhancement'
assignees: ''

---
Expand All @@ -13,8 +13,8 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
**Describe any alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
Add any other context or screenshots about the feature request here. **Include screenshots if needed**.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/perf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Performance
about: Suggest a change that would impact the performance of an application
title: "perf(scope-of-issue): description"
labels: 'infra'
assignees: ''

---

**What should we improve? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe any alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here. **Include screenshots if needed**.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Testing
about: Suggest a testing addition or change
title: "test(scope-of-issue): description"
labels: 'testing'
assignees: ''

---

**What tests should we change? What type of tests are we adding? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe what the new additions would do**
A clear and concise description of what you want to happen.

**Additional context**
Add any other context or screenshots about the feature request here. **Include screenshots if needed**.
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Build
about: Upgrade the build for this project
title: "build(scope-of-PR): description of PR"
labels: 'dependencies'
assignees: ''
---

# Description

Describe your PR with the following guidelines

## What changes does this PR add?

Explain your additions to our current build.

## **Why do we need to add to the build? How does this PR address the issue(s)?**

Showcase why we need to add/change our current build. What problem does it solve? Does it answer the linked issue(s)?

## Dependency Changes (if applicable)

If there are any dependency changes, list them here.

## Before and After Screenshots (if applicable)

| Before | After |
| :-------------------: | :------------------: |
| BEFORE IMAGES GO HERE | AFTER IMAGES GO HERE |

## Additional comments (if applicable)

If there are any comments to add, list them here. You can also link the according issue here as well (if applicable).

# Checklist

Make sure your PR follows the according checklist in the docs [contribution guidelines](http://localhost:3000/docs/contribution-guidelines/pull-requests).
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/chore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Chore
about: Complete a chore for the project
title: "chore(scope-of-PR): description of PR"
labels: ''
assignees: ''
---

# Description

Describe your PR with the following guidelines

## What changes does this PR add?

Explain your additions/changes to the project.

## **Why do we need to update the project? How does this PR address the issue(s)?**

Showcase why we need to add/change our current project. What problem does it solve? Does it answer the linked issue(s)?

## Dependency Changes (if applicable)

If there are any dependency changes, list them here.

## Before and After Screenshots (if applicable)

| Before | After |
| :-------------------: | :------------------: |
| BEFORE IMAGES GO HERE | AFTER IMAGES GO HERE |

## Additional comments (if applicable)

If there are any comments to add, list them here. You can also link the according issue here as well (if applicable).

# Checklist

Make sure your PR follows the according checklist in the docs [contribution guidelines](http://localhost:3000/docs/contribution-guidelines/pull-requests).
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/ci.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Continuous Integration
about: Add to the CI of the project
title: "ci(scope-of-PR): description of PR"
labels: ''
assignees: ''
---

# Description

Describe your PR with the following guidelines

## What changes does this PR add?

Explain your additions/changes to the project.

## **Why do we need to update the pipeline? How does this PR address the issue(s)?**

Showcase why we need to add/change our current pipeline. What problem does it solve? Does it answer the linked issue(s)?

## Dependency Changes (if applicable)

If there are any dependency changes, list them here.

## Before and After Screenshots (if applicable)

| Before | After |
| :-------------------: | :------------------: |
| BEFORE IMAGES GO HERE | AFTER IMAGES GO HERE |

## Additional comments (if applicable)

If there are any comments to add, list them here. You can also link the according issue here as well (if applicable).

# Checklist

Make sure your PR follows the according checklist in the docs [contribution guidelines](http://localhost:3000/docs/contribution-guidelines/pull-requests).
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Docs
about: Add to the docs for this project
title: "docs(scope-of-PR): description of PR"
labels: 'documentation'
assignees: ''
---

# Description

Describe your PR with the following guidelines

## What changes does this PR add?

Explain your additions to the docs site.

## **Why do we need to add to the docs? How does this PR address the issue(s)?**

Showcase why we need to add to the docs site. What problem does it solve? Does it answer the linked issue(s)?

## Dependency Changes (if applicable)

If there are any dependency changes, list them here.

## Before and After Screenshots (if applicable)

| Before | After |
| :-------------------: | :------------------: |
| BEFORE IMAGES GO HERE | AFTER IMAGES GO HERE |

## Additional comments (if applicable)

If there are any comments to add, list them here. You can also link the according issue here as well (if applicable).

# Checklist

Make sure your PR follows the according checklist in the docs [contribution guidelines](http://localhost:3000/docs/contribution-guidelines/pull-requests).
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Feature
about: Create a feature for this project
title: "feat(scope-of-PR): description of PR"
labels: 'enhancement'
assignees: ''
---

# Description

Describe your PR with the following guidelines

## What feature(s) does this PR add?

Explain what your feature(s) does.

## **Why do we need this feature? How does this PR address the issue(s)?**

Showcase why we need this feature. What problem does it solve? Does it answer the linked issue?

## Dependency Changes (if applicable)

If there are any dependency changes, list them here.

## Before and After Screenshots (if applicable)

| Before | After |
| :-------------------: | :------------------: |
| BEFORE IMAGES GO HERE | AFTER IMAGES GO HERE |

## Additional comments (if applicable)

If there are any comments to add, list them here. You can also link the according issue here as well (if applicable).

# Checklist

Make sure your PR follows the according checklist in the docs [contribution guidelines](http://localhost:3000/docs/contribution-guidelines/pull-requests).
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Fix
about: Fix a reported bug from the project
title: "fix(scope-of-PR): description of PR"
labels: 'bug'
assignees: ''
---

# Description

Describe your PR with the following guidelines

## What changes does this PR add?

Explain your additions/changes to the project.

## **What do need to fix and why? How does this PR address the issue(s)?**

Showcase why we need to fix this bug. What problem does it solve? Does it answer the linked issue(s)?

## Dependency Changes (if applicable)

If there are any dependency changes, list them here.

## Before and After Screenshots (if applicable)

| Before | After |
| :-------------------: | :------------------: |
| BEFORE IMAGES GO HERE | AFTER IMAGES GO HERE |

## Additional comments (if applicable)

If there are any comments to add, list them here. You can also link the according issue here as well (if applicable).

# Checklist

Make sure your PR follows the according checklist in the docs [contribution guidelines](http://localhost:3000/docs/contribution-guidelines/pull-requests).
Loading

0 comments on commit 3de11e5

Please sign in to comment.