From 711f3fe070f2026593a5b8c3e8bd6e51e181d8b9 Mon Sep 17 00:00:00 2001 From: vasilije Date: Sun, 7 Sep 2025 17:15:49 -0700 Subject: [PATCH] added github issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 97 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/documentation.yml | 73 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 78 +++++++++++++++++ .github/pull_request_template.md | 45 +++++++++- 5 files changed, 300 insertions(+), 1 deletion(-) 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..7705a51eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,97 @@ +name: 🐛 Bug Report +description: Report a bug or unexpected behavior +title: "[Bug]: " +labels: ["bug", "needs-triage"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Please provide a clear and detailed description. + + - type: textarea + id: description + attributes: + label: Bug Description + description: Please provide a clear and concise description of the bug. What happened vs what you expected? + placeholder: Describe the bug in detail... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Please provide detailed steps to reproduce the issue + placeholder: | + 1. Go to... + 2. Click on... + 3. See error... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: Describe what you expected... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + placeholder: Describe what actually happened... + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Please provide your environment details + placeholder: | + - OS: [e.g. macOS 13.0, Ubuntu 20.04] + - Python version: [e.g. 3.9.0] + - Cognee version: [e.g. 0.1.0] + - LLM Provider: [e.g. OpenAI, Ollama] + - Database: [e.g. Neo4j, FalkorDB] + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs/Error Messages + description: Please include any relevant logs or error messages + placeholder: Paste logs here... + render: shell + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the problem here + placeholder: Any additional information... + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Pre-submission Checklist + description: Please confirm the following before submitting + options: + - label: I have searched existing issues to ensure this bug hasn't been reported already + required: true + - label: I have provided a clear and detailed description of the bug + required: true + - label: I have included steps to reproduce the issue + required: true + - label: I have included my environment details + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..2d6a38e3e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Discord Community + url: https://discord.gg/NQtRemgQVD + about: Join our Discord community for questions, discussions, and support + - name: 📖 Documentation + url: https://docs.cognee.ai + about: Check our documentation for guides and API references diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..417289f5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,73 @@ +name: 📚 Documentation Issue +description: Report an issue with documentation or suggest documentation improvements +title: "[Docs]: " +labels: ["documentation", "needs-triage"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for helping improve our documentation! Please provide details about the documentation issue or improvement. + + - type: dropdown + id: doc-type + attributes: + label: Documentation Type + description: What type of documentation issue is this? + options: + - Missing documentation + - Incorrect documentation + - Unclear documentation + - Documentation improvement + - New documentation request + validations: + required: true + + - type: textarea + id: location + attributes: + label: Documentation Location + description: Where is the documentation issue located? (URL, file path, section, etc.) + placeholder: https://cognee.ai/docs/... or specific file/section + validations: + required: true + + - type: textarea + id: issue + attributes: + label: Issue Description + description: Please describe the documentation issue or improvement needed + placeholder: The documentation is unclear about... + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Suggested Improvement + description: How would you improve this documentation? + placeholder: I suggest changing this to... + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the documentation issue + placeholder: Additional context... + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Pre-submission Checklist + description: Please confirm the following before submitting + options: + - label: I have searched existing issues to ensure this documentation issue hasn't been reported already + required: true + - label: I have provided a clear description of the documentation issue + required: true + - label: I have specified the location of the documentation issue + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..cf743e6e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,78 @@ +name: 🚀 Feature Request +description: Suggest a new feature or enhancement +title: "[Feature]: " +labels: ["enhancement", "needs-triage"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature! Please provide a clear and detailed description of your idea. + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: Is your feature request related to a problem? Please describe the problem you're trying to solve. + placeholder: I'm always frustrated when... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like to see implemented + placeholder: I would like to see... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Describe any alternative solutions or features you've considered + placeholder: I have also considered... + validations: + required: false + + - type: textarea + id: use-case + attributes: + label: Use Case + description: Describe your specific use case and how this feature would help + placeholder: This feature would help me... + validations: + required: true + + - type: textarea + id: implementation + attributes: + label: Implementation Ideas + description: If you have ideas about how this could be implemented, please share them + placeholder: This could be implemented by... + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context, screenshots, or examples about the feature request + placeholder: Additional context... + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Pre-submission Checklist + description: Please confirm the following before submitting + options: + - label: I have searched existing issues to ensure this feature hasn't been requested already + required: true + - label: I have provided a clear problem statement and proposed solution + required: true + - label: I have described my specific use case + required: true + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 06d4c05da..76ff5965c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,50 @@ ## Description - + + +## Type of Change + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Documentation update +- [ ] Code refactoring +- [ ] Performance improvement +- [ ] Other (please specify): + +## Changes Made + +- +- +- + +## Testing + + +## Screenshots/Videos (if applicable) + + +## Pre-submission Checklist + +- [ ] **I have tested my changes thoroughly before submitting this PR** +- [ ] **This PR contains minimal changes necessary to address the issue/feature** +- [ ] My code follows the project's coding standards and style guidelines +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have added necessary documentation (if applicable) +- [ ] All new and existing tests pass +- [ ] I have searched existing PRs to ensure this change hasn't been submitted already +- [ ] I have linked any relevant issues in the description +- [ ] My commits have clear and descriptive messages + +## Related Issues + + +## Additional Notes + ## DCO Affirmation I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin.