Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add issue and pull request templates #1232

Merged
merged 3 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened and what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Describe how to reproduce the bug
placeholder: Step by step method to recreate the issue.
validations:
required: true
- type: input
id: Version
attributes:
label: version
description: What version of the software are you using?
- type: textarea
id: logs
attributes:
label: Relevant logs or stack trace
description: Please copy and paste any relevant output from the code. This will be automatically formatted so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Docs Issue
description: Report an error or omission in the documentation.
title: "[Docs]: "
labels: ["docs", "triage"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to let us know how we can improve the docs!
- type: input
id: docs_page_link
attributes:
label: What page needs improvement?
value: Link a URL
- type: textarea
id: description
attributes:
label: Description
description: Please describe the way the docs didn't meet your needs.
- type: textarea
id: remedy
attributes:
label: Remedy
description: Please describe what you think needs to be added or changed for the docs to meet your needs.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Feature Request
description: Request an enhancement or new feature
title: "[Feature]: "
body:
- type: textarea
id: inspiration
attributes:
label: Inspiration
description: What are you trying to accomplish but finding hard or not possible?
placeholder: What's your end goal?
validations:
required: true
- type: textarea
id: valueadd
attributes:
label: Use Cases and Audiences
description: What new possibilities does this feature enable, and what types of users will find it helpful?
placeholder: Who is the audience and what new applications would this feature enable?
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/unclassified.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Unclassified Issue
description: Open an issue
title: "[Unclassified]: "
labels: ["unclassified", "triage"]
body:
- type: markdown
attributes:
value: Please open a Feature Request, Docs, or Bug Report issue, but if none of those are applicable you can use this generic form.
- type: textarea
id: description
attributes:
label: Issue Description
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
### What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)

---
### What is the current behavior? (You can also link to an open issue here)

---
### What is the new behavior (if this is a feature change or bug fix)

---
### Does this PR introduce a breaking change?
If so, please describe what changes users might need to make as a result of this PR.

---
### Associated Issues
Give a link to the relevant open issue(s) this PR addresses in this repository and others. If it resolves an issue, use `closes: #ddd`.

---
### Required for all PRs:

- [ ] I have read and agree to follow the [Code of Conduct](../../../CODE_OF_CONDUCT.md) for this project.
- [ ] I have read and followed the guidelines in the [Contributor's Guide](../../../CONTRIBUTING.md).
- [ ] I understand I should follow the guidelines in the [Security Guide](../../../SECURITY.md) for any security-related issues or PRs.
- [ ] I have checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change.
- [ ] If applicable, I have written the appropriate tests for my new code.
- [ ] If applicable, I have updated the appropriate documentation for new, updated, deprecated, or removed functionality.
- [ ] I have run the linter on my code prior to submitting the PR.
- [ ] All tests are passing locally for me.
- [ ] My PR has a valid [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) title
---
Loading