diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..e15afd5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,133 @@ +name: ๐Ÿž Bug Report +description: "File a new bug report." +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + > [!IMPORTANT] + > **Please ensure you are using the latest version of Cloudness before submitting an issue, as the bug may have already been fixed in a recent update.** + + Thanks for taking the time to fill out this bug report! The more details you provide, the faster we can help. + + - type: textarea + attributes: + label: Description + description: A clear and concise description of what the bug is. + placeholder: Describe the bug... + validations: + required: true + + - type: textarea + attributes: + label: Error Message and Logs + description: Provide any error messages or relevant log output. + render: shell + validations: + required: false + + - type: textarea + attributes: + label: Steps to Reproduce + description: Please provide a step-by-step guide to reproduce the issue. Be as detailed as possible. + value: | + 1. + 2. + 3. + 4. + validations: + required: true + + - type: textarea + attributes: + label: Expected Behavior + description: What did you expect to happen? + validations: + required: true + + - type: textarea + attributes: + label: Actual Behavior + description: What actually happened instead? + validations: + required: true + + - type: input + attributes: + label: Cloudness Version + description: Run `cloudness version` or check your deployment. Found in the UI footer or logs. + placeholder: "v1.0.0" + validations: + required: true + + - type: dropdown + attributes: + label: Installation Type + description: How is Cloudness deployed? + options: + - Self-hosted (Kubernetes) + - Other + validations: + required: true + + - type: input + attributes: + label: Kubernetes Version + description: Run `kubectl version --short` and provide the server version. + placeholder: "v1.28.0" + validations: + required: false + + - type: dropdown + attributes: + label: Kubernetes Distribution + description: What Kubernetes distribution are you using? + options: + - k3s + - k8s (vanilla) + - EKS (AWS) + - GKE (Google) + - AKS (Azure) + - minikube + - kind + - Rancher + - OpenShift + - Other + validations: + required: false + + - type: input + attributes: + label: Operating System + description: Run `cat /etc/os-release` or provide your OS version. + placeholder: "Ubuntu 22.04" + validations: + required: false + + - type: input + attributes: + label: Browser (if UI issue) + description: Provide browser name and version if this is a UI-related issue. + placeholder: "Chrome 120" + validations: + required: false + + - type: textarea + attributes: + label: Additional Context + description: Any other relevant information, screenshots, or context about the issue. + validations: + required: false + + - type: checkboxes + attributes: + label: Checklist + description: Please confirm the following before submitting. + options: + - label: I have searched existing issues to ensure this bug hasn't been reported. + required: true + - label: I am using the latest version of Cloudness (or have noted my version above). + required: true + - label: I have provided all the information needed to reproduce this issue. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..244178f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: ๐Ÿ“– Documentation + url: https://docs.cloudness.io + about: Check the documentation for answers to common questions + - name: ๐Ÿ’ฌ Discussions + url: https://github.com/cloudness-io/cloudness/discussions + about: Ask questions and discuss with the community + - name: ๐Ÿ”’ Security Vulnerability + url: https://github.com/cloudness-io/cloudness/security/advisories/new + about: Report security vulnerabilities privately (do not use public issues) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..b7df0c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,73 @@ +name: โœจ Feature Request +description: "Suggest an idea or enhancement for Cloudness." +title: "[Feature]: " +labels: ["enhancement", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting an improvement! Please fill out the details below to help us understand your request. + + - type: textarea + attributes: + label: Problem Statement + description: Is your feature request related to a problem? Please describe. + placeholder: "I'm always frustrated when..." + validations: + required: true + + - type: textarea + attributes: + label: Proposed Solution + description: Describe the solution you'd like. Be as detailed as possible. + validations: + required: true + + - type: textarea + attributes: + label: Alternatives Considered + description: Describe any alternative solutions or workarounds you've considered. + validations: + required: false + + - type: dropdown + attributes: + label: Feature Area + description: What area of Cloudness does this relate to? + options: + - Deployment / CI/CD + - UI / Dashboard + - CLI + - Authentication / Authorization + - Templates + - Kubernetes Integration + - Database / Storage + - Logging / Monitoring + - Documentation + - Other + validations: + required: true + + - type: textarea + attributes: + label: Use Case + description: Describe your use case and how this feature would benefit you and others. + validations: + required: false + + - type: textarea + attributes: + label: Additional Context + description: Add any other context, mockups, screenshots, or examples about the feature request. + validations: + required: false + + - type: checkboxes + attributes: + label: Checklist + description: Please confirm the following before submitting. + options: + - label: I have searched existing issues to ensure this feature hasn't been requested. + required: true + - label: I would be willing to help implement this feature. + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b7be6e8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,52 @@ +## Description + + + +## Related Issue + + +Fixes # + +## Type of Change + + + +- [ ] ๐Ÿ› 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 change) +- [ ] ๐Ÿ“ Documentation update +- [ ] ๐Ÿ”ง Configuration change +- [ ] โ™ป๏ธ Refactoring (no functional changes) +- [ ] ๐Ÿงช Test update + +## How Has This Been Tested? + + + +- [ ] Unit tests +- [ ] Integration tests +- [ ] Manual testing + +**Test Environment:** + +- Kubernetes Version: +- OS: + +## Screenshots (if applicable) + + + +## Checklist + +- [ ] My code follows the project's style guidelines +- [ ] I have performed a self-review of my 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 tests pass locally with my changes +- [ ] Any dependent changes have been merged and published + +## Additional Notes + +