Skip to content

Commit

Permalink
Update Issue & PR templates (#4)
Browse files Browse the repository at this point in the history
* Update PR template

* Add new bug report template

* Add new feature request template
  • Loading branch information
Kostis-S-Z authored Dec 5, 2024
1 parent a78c303 commit 97ecd78
Show file tree
Hide file tree
Showing 5 changed files with 155 additions and 54 deletions.
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: "\U0001F41B Bug Report"
description: Submit a bug report to help us improve
title: "[BUG]: "
projects:
- "project-name"
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please make sure you have searched for a similar [issue](https://github.com/mozilla-ai/project-name/issues) before submitting a new one.
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is.
placeholder: |
When I try to...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction
description: |
Provide a numbered list of steps that one can follow to reproduce this behavior.
placeholder: |
Steps to reproduce the behavior:
1.
2.
3.
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
validations:
required: false

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear description of what you would expect to happen.
placeholder: "I would expect to..."
validations:
required: true

- type: textarea
id: system-info
attributes:
label: System Info
description: Please share your system info with us.
placeholder: |
- OS: [e.g., macOS Sonoma]
- Project-name version: [e.g. commit SHA]
validations:
required: true

- type: checkboxes
id: search
attributes:
label: Have you searched for similar issues before submitting this one?
options:
- label: Yes, I have searched for similar issues
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: "\U0001F680 Feature Request"
description: Suggest an idea for this project
title: "[FEATURE]: "
projects:
- "Project-name"
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this form!
Please make sure you have searched for a similar [issue](https://github.com/mozilla-ai/project-name/issues) before submitting a new one.
- type: textarea
id: motivation
attributes:
label: Motivation
description: |
A clear and concise description of the proposal and why this is important.
placeholder: |
I'm always frustrated when...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: |
A clear and concise description of any alternative solutions or features you've considered.
placeholder: |
I've considered...
validations:
required: false

- type: textarea
id: contribution
attributes:
label: Contribution
description: |
Is there any way that you could help, e.g. by submitting a PR?
Make sure to read the [contribution guidelines](https://github.com/mozilla-ai/project-name/blob/main/CONTRIBUTING.md).
placeholder: |
I could help by...
validations:
required: false

- type: checkboxes
id: search
attributes:
label: Have you searched for similar issues before submitting this one?
options:
- label: Yes, I have searched for similar issues
required: true
28 changes: 25 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
## What's changing
# What's changing

## How to test it
Provide a clear and concise description of the content changes you're proposing. List all the
changes you are making to the content.

## Additional notes for reviewers
> If this PR is related to an issue or closes one, please link it here.
Refs #...
Closes #...

# How to test it

Steps to test the changes:

1.
2.
3.

# Additional notes for reviewers

Anything you'd like to add to help the reviewer understand the changes you're proposing.

# I already...

- [ ] Tested the changes in a working environment to ensure they work as expected
- [ ] Added some tests for any new functionality
- [ ] Updated the documentation (both comments in code and under `/docs`)

0 comments on commit 97ecd78

Please sign in to comment.