diff --git a/ISSUE_TEMPLATE/bug_report.yml b/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..8c2cd62 --- /dev/null +++ b/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,88 @@ +name: Bug Report +description: Report a bug in an OKDP component +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + > [!WARNING] + > **Security vulnerability?** Do not open a public issue. + > Please use [GitHub's private vulnerability reporting](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability) on the affected repository instead. + + - type: textarea + id: description + attributes: + label: Describe the Bug + description: A clear description of what the bug is. + validations: + required: true + + - type: textarea + id: repro + attributes: + label: Steps to Reproduce + description: List the exact steps to trigger the bug. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + value: | + **Kubernetes version** +
+ + ```console + $ kubectl version + # paste output here + ``` + +
+ + **Helm version** +
+ + ```console + $ helm version + # paste output here + ``` + +
+ + **Chart / component version:** + + **Cluster setup (Kind version, node count, any custom config):** + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs + description: Paste relevant logs here. + render: shell + + - type: textarea + id: additional + attributes: + label: Anything else we need to know? + description: Workarounds you found, related issues, hypotheses about the root cause, or any other context that might help. diff --git a/ISSUE_TEMPLATE/config.yml b/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8b3a052 --- /dev/null +++ b/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +blank_issues_enabled: false + +contact_links: + - name: GitHub Discussions + url: https://github.com/orgs/OKDP/discussions + about: Questions, ideas, and general discussions; ask here before opening an issue. + + - name: OKDP Documentation + url: https://okdp.io + about: Check the official docs and roadmap before opening an issue. diff --git a/ISSUE_TEMPLATE/feature_request.yml b/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..1010db0 --- /dev/null +++ b/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,38 @@ +name: Feature Request +description: Suggest a new feature or improvement +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + > [!NOTE] + > **Proposing a significant change?** Open a [GitHub Discussion](https://github.com/orgs/OKDP/discussions) first. + > Large features benefit from community alignment before becoming a tracked issue. + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem does this feature solve? + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Any alternative solutions you've considered. + + - type: textarea + id: context + attributes: + label: Additional Context + description: Any other context, screenshots, or references. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3c688ea --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ + + +## Description + + + +## Related Issue + +Fixes # + +## Type of Change + +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Refactor / chore +- [ ] Breaking change + + + +## How to Test + + + + +## Checklist + + +- [ ] I have tested my changes +- [ ] Documentation updated if needed +- [ ] If breaking change: migration path described above +- [ ] I hereby declare this contribution to be licensed under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). +- [ ] I hereby agree to grant [TOSIT](https://www.tosit.io/) a copyright license to use my contributions. \ No newline at end of file