diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..52ae0039 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,31 @@ +--- +name: Bug Report +about: Report a bug for the validated pattern. +title: "[Bug]: " +labels: bug +assignees: '' +--- + +### Description +A clear and concise description of the bug. + +### Steps to Reproduce +1. Install the pattern +2. Go to X +3. See Y + + +### Expected Behavior +Explain what you expected to happen. + +### Screenshots +Add screenshots if applicable. + +### Environment +- Hardware / cloud provide (e.g. Azure; Intel Barel metal; AMD Bare metal) +- CPU Specs and/or cloud instance types. +- Cluster topology (one cluster; SNO; multi-cluster) +- Connected or disconnected + +### Additional Context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..bca2bc53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,17 @@ +blank_issues_enabled: false +issue_templates: + - name: "Bug Report" + description: "Report a bug in the system." + title: "[Bug]: " + labels: ["bug"] + body: "./ISSUE_TEMPLATE/bug_report.md" + - name: "Feature Request" + description: "Propose a new feature or improvement." + title: "[Feature]: " + labels: ["enhancement"] + body: "./ISSUE_TEMPLATE/feature_request.md" + - name: "Documentation" + description: "Suggest updates or additions to the documentation." + title: "[Docs]: " + labels: ["documentation"] + body: "./ISSUE_TEMPLATE/documentation.md" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 00000000..2b32dcf8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,19 @@ +--- +name: Documentation +about: Suggest updates or additions to documentation +title: "[Docs]: " +labels: documentation +assignees: '' +--- + +### Documentation Update +What part of the documentation needs to be updated or added? Is it for the validated patterns docs site or the repo docs. + +### Why Is This Needed? +Explain the importance of this update. + +### Suggested Changes +Provide a detailed description of the changes. + +### Additional Context +Include any related resources. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..25cec83d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,22 @@ +--- +name: Feature Request +about: Suggest a new feature or improvement +title: "[Feature]: " +labels: enhancement +assignees: '' +--- + +### Feature Description +What feature would you like to see? + +### Why Is This Needed? +Explain the problem or need for this feature. + +### Suggested Solutions +Describe how this feature could be implemented. + +### Proposed Acceptance criteria +Discrete acceptance criteria, suitable for evaluation by a LLM + +### Additional Context +Add any relevant screenshots, links, or resources.