Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
nanderstabel authored Oct 18, 2023
0 parents commit e905c7a
Show file tree
Hide file tree
Showing 5 changed files with 177 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Bug report
description: Create a report to help us fix issues
title: "[Bug] "
labels: ["Bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: Description
description: Briefly describe the bug.
validations:
required: true
- type: textarea
id: hardware
attributes:
label: Hardware Specification
description: What hardware are you using? Please provide what is relevant.
value: |
Operating system:
RAM:
Cores:
Device:
validations:
required: false
- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce the Bug
description: Explain how the maintainer can reproduce the bug.
value: |
1.
2.
3.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behaviour
description: Describe what you expect to happen.
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behaviour
description: Describe what actually happens.
validations:
required: true
- type: textarea
id: errors
attributes:
label: Errors
description: Paste any errors that you see, including logs, errors, or screenshots.
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Company Website
url: https://impierce.com/
about: "Contact us in the contact form for any questions."
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/suggestion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: 'Feature Request'
description: "Request a feature or provide a suggestion"
title: "[Request] "
labels: ["Request"]
body:
- type: markdown
attributes:
value: |
You are requesting a feature or suggesting something to the maintainers.
- type: textarea
id: description
attributes:
label: Description
description: Briefly describe the feature that you are requesting.
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: Explain why this feature is needed.
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
description: Write a list of what you want this feature to do.
value: |
1.
2.
3.
validations:
required: true
- type: textarea
id: openqs
attributes:
label: Open Questions
description: Use this section to ask any questions that are related to the feature.
validations:
required: false
- type: dropdown
id: doit
attributes:
label: Are you planning to contribute this in a PR?
options:
- "Yes"
- "No"
validations:
required: true
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: 'Task'
description: Add a task (Only use if you are a maintainer)
labels: []
body:
- type: markdown
attributes:
value: |
You are writing a task for the maintainers of this repository. If you are not a maintainer yourself, instead submit a bug report or suggestion.
- type: textarea
id: description
attributes:
label: Description
description: Describe the task, this may be scoped beyond a single PR.
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: Describe the motivation for the feature to be developed.
validations:
required: false
- type: textarea
id: resources
attributes:
label: Resources
description: Link to any resources relevant for the task such as issues, PRs, reference implementations, or specifications.
placeholder: |
Depends on \#1 and \#2
[Link to relevant resources](www.impierce.com)
validations:
required: false
- type: textarea
id: todo
attributes:
label: To-do List
description: Create a task-specific to-do list. Please link PRs that match the TODO list item behind the item after it has been submitted.
value: |
- [ ] Item one
- [ ] Item two
- [ ] Item three
validations:
required: true
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Description of change
Please write a summary of your changes and why you made them.

## Links to any relevant issues
Be sure to reference any related issues by adding `fixes issue #`.

## How the change has been tested
Describe the tests that you ran to verify your changes.
Make sure to provide instructions for the maintainer as well as any relevant configurations.

## Definition of Done checklist
Add an `x` to the boxes that are relevant to your changes.

- [ ] I have followed the contribution guidelines for this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes

0 comments on commit e905c7a

Please sign in to comment.