From 798b371a31bac3abfc86951965a3ad984a4182db Mon Sep 17 00:00:00 2001 From: David Kornel Date: Thu, 23 May 2024 09:14:57 +0200 Subject: [PATCH] Create pull request and issue templates (#85) Signed-off-by: David Kornel --- .github/ISSUE_TEMPLATE/bug_report.yml | 54 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/documentation.yml | 20 ++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 34 ++++++++++++++ .github/pull_request_template.md | 25 ++++++++++ 5 files changed, 138 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..de9ce13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,54 @@ +--- +name: Bug report +description: Create a report to help us improve +title: '[Bug]: ' +labels: ['bug', 'needs-triage'] +body: + - type: markdown + attributes: + value: _Please use this only for bug reports. For questions or when you need help, you can use the [GitHub Discussions](https://github.com/skodjob/test-frame/discussions)._ + - type: textarea + attributes: + label: Bug Description + description: Describe the bug + placeholder: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + attributes: + label: Expected behavior + description: What is the behavior you expected to see? Please describe. + placeholder: A clear and concise description of what you expected to happen. + validations: + required: false + - type: input + id: test-frame-version + attributes: + label: TEST-FRAME version + description: Test-Frame version where the bug occurred + placeholder: e.g. main, 0.1.0 + validations: + required: true + - type: input + id: kubernetes-version + attributes: + label: Kubernetes version + description: Kubernetes version where the bug occurred + placeholder: e.g. Kubernetes 1.25, OpenShift 4.11 + validations: + required: true + - type: textarea + attributes: + label: Logs + description: All relevant configuration and log files + placeholder: | + Attach or copy and paste the relevant logs. + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: Any additional context related to the problem + placeholder: Add any other context about the problem here. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8b2e987 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Questions and Discussions + url: https://github.com/skodjob/test-frame/discussions + about: Please ask and discuss questions here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..c4d8d6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,20 @@ +--- +name: Documentation +description: Report a bug or suggest an idea for our documentation +title: '[Docs]: ' +labels: ['documentation', 'needs-triage'] +body: + - type: textarea + attributes: + label: Suggestion / Problem + description: Suggestion / Problem + placeholder: Describe your problem or suggestion + validations: + required: true + - type: textarea + attributes: + label: Documentation Link + description: Link(s) to the relevant documentation + placeholder: Provide link(s) to the documentation where the bug / suggestion should be applied + validations: + required: false \ 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..33965a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +--- +name: Feature request +description: Suggest an idea for this project +title: '[Enhancement]: ' +labels: ['enhancement', 'needs-triage'] +body: + - type: textarea + attributes: + label: Related problem + description: Is your feature request related to a problem? Please describe. + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when ... + validations: + required: false + - type: textarea + attributes: + label: Suggested solution + description: Describe the solution you'd like + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Alternatives + description: Describe alternatives you've considered + placeholder: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: Additional context + placeholder: Add any other context or screenshots about the feature request here. + validations: + required: false \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8023202 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,25 @@ +# Pull Request Template + +## Description + +_Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change._ + + +## Type of Change + +Please delete options that are not relevant. + +* Bug fix (non-breaking change which fixes an issue) +* New feature (non-breaking change which adds functionality) +* Breaking change (fix or feature that would cause existing functionality to not work as expected) +* Documentation update + +## Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit/integration tests pass locally with my changes