Skip to content

Commit

Permalink
added issue and PR templates (#118)
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesDCowley authored Jan 29, 2025
1 parent a042b82 commit 1c8076c
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text eol=lf
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Please switch to **Preview** and select one of the following links:

* [Feature](?template=feature.md)
* [Bug](?template=bug.md)

Once switched to the correct template, you can save the link as a bookmark. Keep in mind that switching templates will remove all already entered data within this issue.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Bug Issue Template
about: Report a bug
title: '[BUG] <title>'
labels: bug
assignees: ''
---
<!-- Bug template !-->
## Summary

## Steps to reproduce

## Environment
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: New Feature Issue Template
about: Recommend a new feature
title: '[FEATURE] <title>'
labels: enhancement
assignees: ''
---
<!-- New feature template !-->
## Story
* **As a**
* **I want**
* **So that**

## Acceptance Criteria

- [ ] Does this
- [ ] Does that
- [ ] Is Amazing

## Technical Details
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## Summary

## How was this tested
- [ ] Added new unit tests
- [ ] Ran code on hardware (screenshots are helpful)
- [ ] Other (Please describe)
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ repos:
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
# - id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
- id: mixed-line-ending
Expand Down

0 comments on commit 1c8076c

Please sign in to comment.