Merge pull request #111 from agu3rra/github.templates

process enhancement: adds templates to the repo
This commit is contained in:
Daniel Miessler 2024-02-17 16:45:28 -08:00 committed by GitHub
commit 86ba1ade46
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 71 additions and 0 deletions

37
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@ -0,0 +1,37 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug"]
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?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "I was doing THIS, when THAT happened. I was expecting THAT_OTHER_THING to happen instead."
validations:
required: true
- type: checkboxes
id: version
attributes:
label: Version check
description: Please make sure you were using the latest version of this project available in the `main` branch.
options:
- label: Yes I was.
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
- type: textarea
id: screens
attributes:
label: Relevant screenshots (optional)
description: Please upload any screenshots that may help us reproduce and/or understand the issue.

View File

@ -0,0 +1,13 @@
name: Feature Request
description: Suggest features for this project.
title: "[Feature request]: "
labels: ["enhancement"]
body:
- type: textarea
id: description
attributes:
label: What do you need?
description: Tell us what functionality you would like added/modified?
value: "I want the CLI to do my homework for me."
validations:
required: true

12
.github/ISSUE_TEMPLATE/question.yml vendored Normal file
View File

@ -0,0 +1,12 @@
name: Question
description: Ask us questions about this project.
title: "[Question]: "
labels: ["question"]
body:
- type: textarea
id: description
attributes:
label: What is your question?
value: "After reading the documentation, I am still not clear how to get X working. I tried this, this, and that."
validations:
required: true

9
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,9 @@
## What this Pull Request (PR) does
Please briefly describe what this PR does.
## Related issues
Please reference any open issues this PR relates to in here.
If it closes an issue, type `closes #[ISSUE_NUMBER]`.
## Screenshots
Provide any screenshots you may find relevant to facilitate us understanding your PR.