From 48bda7a4900b584c5a78d2eba43afdce972c4514 Mon Sep 17 00:00:00 2001 From: agu3rra Date: Sat, 17 Feb 2024 14:35:07 -0300 Subject: [PATCH] adds templates on the repo --- .github/ISSUE_TEMPLATE/bug.yml | 37 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 13 ++++++++ .github/ISSUE_TEMPLATE/question.yml | 12 +++++++ .github/pull_request_template.md | 9 ++++++ 4 files changed, 71 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..602d0e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..7510ea1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..1c201e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -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 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..90e8adc --- /dev/null +++ b/.github/pull_request_template.md @@ -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.