Skip to content

Home Information - Your home, your data, organized.

Python

Added GitHub issue templates.

Anthony Cassandra0937ea86e422
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..5359dae4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,36 @@
+---
+name: "Bug Report"
+about: Report a bug or unexpected behavior.
+title: "[Bug] Short description of the issue"
+labels: bug
+assignees: ''
+
+---
+
+## Bug Description
+<!-- A clear and concise description of what the bug is. -->
+
+## Steps to Reproduce
+1. Go to '...'
+2. Click on '...'
+3. See error '...'
+
+## Expected Behavior
+<!-- Describe what you expected to happen instead. -->
+
+## Screenshots (if applicable)
+<!-- Add screenshots to help visualize the problem. -->
+
+## Environment
+- **OS:** [e.g., Windows 11, macOS 14, Ubuntu 22.04]
+- **Browser:** [if applicable]
+- **Other relevant details:**
+
+## Additional Context
+<!-- Add any other context, logs, or error messages that might help diagnose the issue. -->
+
+---
+
+### Checklist
+- [ ] I have searched for existing issues that describe this bug.
+- [ ] I have provided enough information for maintainers to reproduce the issue.
diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml
new file mode 100644
index 00000000..d3f44279
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yaml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+ - name: General Questions
+ url: https://github.com/cassandra/home-information/discussions
+ about: Use GitHub Discussions for general help or feature requests.
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 00000000..bf15e5ef
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,28 @@
+---
+name: "Documentation Issue"
+about: "Report missing or incorrect documentation."
+title: "[Docs] Short description"
+labels: ["documentation"]
+assignees: ''
+---
+
+## Documentation Issue
+
+### What needs to be updated?
+<!-- Describe the documentation that is missing, incorrect, or unclear. -->
+
+### Link to Affected Page(s)
+<!-- Provide a link to the specific documentation page if applicable. -->
+
+### Suggested Improvement
+<!-- How should this documentation be improved? -->
+
+### Additional Context
+<!-- Add any other context or screenshots related to this issue. -->
+
+---
+
+### Checklist
+- [ ] I have checked for existing documentation issues.
+- [ ] I have provided a link to the affected documentation if applicable.
+- [ ] I have described what needs to be improved.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..ed36e8ba
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,28 @@
+---
+name: "Feature Request"
+about: "Suggest a new feature or improvement."
+title: "[Feature] Short description"
+labels: ["enhancement"]
+assignees: ''
+---
+
+## Feature Request
+
+### Is your feature request related to a problem? Please describe.
+<!-- A clear and concise description of what the problem is. Ex: "I'm frustrated when..." -->
+
+### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+### Alternatives you've considered
+<!-- Any alternative solutions or features you've thought about? -->
+
+### Additional context
+<!-- Add any other context, screenshots, or examples about the feature request here. -->
+
+---
+
+### Checklist
+- [ ] I have searched the existing issues to see if my feature has already been requested.
+- [ ] I have described why this feature would be useful.
+- [ ] I am willing to help implement this feature if needed.
diff --git a/.github/ISSUE_TEMPLATE/operations.md b/.github/ISSUE_TEMPLATE/operations.md
new file mode 100644
index 00000000..8b0cb014
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/operations.md
@@ -0,0 +1,34 @@
+---
+name: "Ops / Deployment Issue"
+about: "Report an issue related to infrastructure, CI/CD, or non-application tasks."
+title: "[Ops] Short description"
+labels: ["ops"]
+assignees: ''
+---
+
+## Ops / Deployment Issue
+
+### What is the issue?
+<!-- Describe the operational issue you are facing (e.g., deployment failure, build issue). -->
+
+### Steps to Reproduce
+<!-- Provide a step-by-step guide to reproduce the problem if applicable. -->
+1. Step 1
+2. Step 2
+3. Step 3
+
+### Related System/Component
+<!-- Specify the system, service, or deployment component affected (e.g., Docker, GitHub Actions, Kubernetes). -->
+
+### Logs / Screenshots (if applicable)
+<!-- Paste any relevant logs or screenshots here. -->
+
+### Suggested Fix (if applicable)
+<!-- If you have any ideas on how this could be fixed, describe them here. -->
+
+---
+
+### Checklist
+- [ ] I have checked for similar existing issues.
+- [ ] I have provided clear steps to reproduce (if applicable).
+- [ ] I have included relevant logs or error messages.
diff --git a/.github/ISSUE_TEMPLATE/refactor.md b/.github/ISSUE_TEMPLATE/refactor.md
new file mode 100644
index 00000000..4388b7a0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/refactor.md
@@ -0,0 +1,36 @@
+---
+name: "Refactor Request"
+about: "Request to refactor existing code without changing behavior."
+title: "[Refactor] Short description"
+labels: ["refactor"]
+assignees: ''
+---
+
+## Refactor Request
+
+### What part of the code needs refactoring?
+<!-- Specify the module, function, or file that needs refactoring. -->
+
+### Why should this be refactored?
+<!-- Clearly explain the reason for refactoring. For example:
+- Code is difficult to understand or maintain.
+- Code violates best practices.
+- There is significant duplication or inefficiency.
+-->
+
+### Expected Outcome
+<!-- Describe the expected benefits of the refactor (e.g., better readability, performance improvements). -->
+
+### Related Code or Files
+<!-- Provide links to the relevant code or mention specific files. -->
+
+### Additional Context
+<!-- Add any other relevant information, examples, or links to discussions. -->
+
+---
+
+### Checklist
+- [ ] I have searched for existing refactor requests.
+- [ ] The refactor does **not** introduce new behavior changes.
+- [ ] The reason for refactoring is clearly justified.
+- [ ] I have provided references to the relevant code.
diff --git a/.github/ISSUE_TEMPLATE/tests.md b/.github/ISSUE_TEMPLATE/tests.md
new file mode 100644
index 00000000..7893f0fa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/tests.md
@@ -0,0 +1,37 @@
+---
+name: "Test Issue"
+about: "Report missing tests, test improvements, or fixes to existing tests."
+title: "[Tests] Short description"
+labels: ["tests"]
+assignees: ''
+---
+
+## Test Issue
+
+### What test-related issue are you reporting?
+<!-- Describe whether it's a missing test, a flaky test, or a needed improvement. -->
+
+### Affected Module or Component
+<!-- Specify the part of the project where the test is missing or failing (e.g., authentication, API, frontend). -->
+
+### Suggested Test Improvement
+<!-- If applicable, describe how the test should be improved or fixed. -->
+
+### Steps to Reproduce (if applicable)
+<!-- If the issue relates to a failing or flaky test, provide steps to reproduce. -->
+1. Step 1
+2. Step 2
+3. Step 3
+
+### Related Test Files
+<!-- Link to or mention the test files that need changes. -->
+
+### Additional Context
+<!-- Any other relevant information, logs, or error messages. -->
+
+---
+
+### Checklist
+- [ ] I have searched for existing test-related issues.
+- [ ] I have described the missing or broken test clearly.
+- [ ] I have provided any necessary logs or test file references.