From 46f613db9e7593a9a613e018894d0479137e06a4 Mon Sep 17 00:00:00 2001 From: Mateusz Urbanek Date: Sun, 29 Sep 2024 12:23:28 +0200 Subject: [PATCH] chore: add issue and pr templates Signed-off-by: Mateusz Urbanek --- .github/ISSUE_TEMPLATE/bug_report.yaml | 20 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 32 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/question.yaml | 12 ++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++ 4 files changed, 80 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/question.yaml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..29b48ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,20 @@ +name: Bug Report +description: You encountered bug? Unexpected behavior? Open this one. +title: "[BUG]: " +labels: + - kind/bug +body: + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also, what did you expect to happen? + placeholder: Put your description here. + 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: Text diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..cc97b16 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,32 @@ +name: Feature Request +description: You want to submit a feature request? Open this one. +title: "[FEATURE]: <title>" +labels: + - kind/feature +body: + - type: textarea + id: description + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like. + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered. + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + id: additional_info + attributes: + label: Additional Information + description: Any other relevant information about the feature request. diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml new file mode 100644 index 0000000..bd99c3e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yaml @@ -0,0 +1,12 @@ +name: Question +description: Have a generic question? Open this one. +title: "[QUESTION]: <title>" +labels: + - kind/support +body: + - type: textarea + id: question + attributes: + label: Ask a question! + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..28b95ca --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +- [ ] Changes covered by unit and/or e2e tests; +- [ ] Documentation and examples updated; + +## What this PR does / why we need it: +<!-- +What code changes are made? +What problem does this PR addresses, or what feature this PR adds? +--> +<!-- REPLACE WITH CONTENT --> + +## Which issue(s) this PR resolves: +<!-- +Usage: `Resolves #<issue number>`, or `Resolves <link to the issue>`. +If PR is about `failing-tests`, please post the related tests in a comment and do not use `Resolves` +--> +Resolves #