From 679848a3b7dcf3de0435ee8920df41535f06d618 Mon Sep 17 00:00:00 2001 From: Andy Lee Date: Fri, 19 Sep 2025 13:51:15 -0700 Subject: [PATCH] simplify: Make templates more concise and user-friendly --- .github/ISSUE_TEMPLATE/bug_report.yml | 136 ++------------------- .github/ISSUE_TEMPLATE/config.yml | 14 +-- .github/ISSUE_TEMPLATE/feature_request.yml | 129 ++----------------- .github/pull_request_template.md | 85 ++----------- 4 files changed, 34 insertions(+), 330 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 56b3050..b18bb62 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,160 +1,50 @@ -name: ๐Ÿ› Bug Report -description: Report a bug or unexpected behavior in LEANN -title: "[BUG] " -labels: ["bug", "triage"] -assignees: [] +name: Bug Report +description: Report a bug in LEANN +labels: ["bug"] body: - - type: markdown - attributes: - value: | - Thanks for taking the time to report this bug! Please fill out the sections below to help us understand and reproduce the issue. - - type: textarea id: description attributes: - label: Bug Description - description: A clear and concise description of what the bug is. - placeholder: | - When I try to build an index with..., I get an error... + label: What happened? + description: A clear description of the bug validations: required: true - type: textarea id: reproduce attributes: - label: Steps to Reproduce - description: Steps to reproduce the behavior + label: How to reproduce placeholder: | - 1. Install LEANN with '...' - 2. Run command '...' + 1. Install with... + 2. Run command... 3. See error - value: | - 1. - 2. - 3. validations: required: true - type: textarea - id: expected + id: error attributes: - label: Expected Behavior - description: What did you expect to happen? - placeholder: The index should build successfully... - validations: - required: true - - - type: textarea - id: actual - attributes: - label: Actual Behavior - description: What actually happened? - placeholder: The process crashed with error... - validations: - required: true - - - type: textarea - id: error-output - attributes: - label: Error Output - description: If applicable, paste any error messages or stack traces + label: Error message + description: Paste any error messages render: shell - placeholder: | - Traceback (most recent call last): - File "...", line X, in - ... - - - type: dropdown - id: backend - attributes: - label: Backend - description: Which backend are you using? - options: - - leann-backend-diskann - - leann-backend-hnsw - - Both - - Not sure - validations: - required: true - type: input id: version attributes: label: LEANN Version - description: What version of LEANN are you using? (run `pip show leann`) placeholder: "0.1.0" validations: required: true - - type: input - id: python-version - attributes: - label: Python Version - description: What version of Python are you using? - placeholder: "3.11.5" - validations: - required: true - - type: dropdown id: os attributes: label: Operating System options: - - macOS (Intel) - - macOS (Apple Silicon) - - Ubuntu/Debian - - Other Linux + - macOS + - Linux - Windows - Docker validations: required: true - - - type: input - id: os-version - attributes: - label: OS Version - description: Please specify your OS version - placeholder: "macOS 14.0, Ubuntu 22.04, etc." - - - type: dropdown - id: installation-method - attributes: - label: Installation Method - description: How did you install LEANN? - options: - - pip install from PyPI - - Built from source with uv - - Docker - - Other - validations: - required: true - - - type: textarea - id: code-sample - attributes: - label: Minimal Reproducible Example - description: If possible, provide a minimal code example that reproduces the issue - render: python - placeholder: | - from leann import LeannBuilder - - # Your code here - - - type: textarea - id: additional-context - attributes: - label: Additional Context - description: Add any other context about the problem here (e.g., dataset size, memory constraints, etc.) - - - type: checkboxes - id: checklist - attributes: - label: Checklist - options: - - label: I have searched the existing issues and this is not a duplicate - required: true - - label: I have read the documentation and followed the setup instructions - required: true - - label: I am using the latest version of LEANN (or have tested with it) - required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index b71f847..ce0f898 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,14 +1,8 @@ blank_issues_enabled: true contact_links: - - name: ๐Ÿ“– Documentation + - name: Documentation url: https://github.com/LEANN-RAG/LEANN-RAG/tree/main/docs - about: Read the documentation for setup and usage instructions - - name: ๐Ÿ’ฌ Discord Community - url: https://discord.gg/your-discord-link - about: Join our Discord for discussions and community support - - name: ๐Ÿค” Discussions + about: Read the docs first + - name: Discussions url: https://github.com/LEANN-RAG/LEANN-RAG/discussions - about: Ask questions and share ideas with the community - - name: ๐Ÿงช Benchmark Question - url: https://github.com/LEANN-RAG/LEANN-RAG/discussions/categories/benchmarks - about: Share or discuss performance benchmarks + about: Ask questions and share ideas diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 3cc34de..0b01b1d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,136 +1,27 @@ -name: โœจ Feature Request -description: Suggest a new feature or enhancement for LEANN -title: "[FEATURE] " -labels: ["enhancement", "triage"] -assignees: [] +name: Feature Request +description: Suggest a new feature for LEANN +labels: ["enhancement"] body: - - type: markdown - attributes: - value: | - Thanks for suggesting a feature! We're always looking for ways to improve LEANN. - - type: textarea id: problem attributes: - label: Problem Statement - description: Is your feature request related to a problem? Please describe. - placeholder: | - I'm always frustrated when... - It would be helpful if... + label: What problem does this solve? + description: Describe the problem or need validations: required: true - type: textarea id: solution attributes: - label: Proposed Solution - description: Describe the solution you'd like - placeholder: | - I would like LEANN to... - The feature should... + label: Proposed solution + description: How would you like this to work? validations: required: true - type: textarea - id: alternatives + id: example attributes: - label: Alternatives Considered - description: Describe any alternative solutions or features you've considered - placeholder: | - I've tried using... - Another approach could be... - - - type: dropdown - id: feature-area - attributes: - label: Feature Area - description: Which area of LEANN does this feature relate to? - options: - - Core API - - DiskANN Backend - - HNSW Backend - - CLI Tools - - Documentation - - Performance - - Testing - - Build/Installation - - Other - validations: - required: true - - - type: dropdown - id: priority - attributes: - label: Priority - description: How important is this feature to you? - options: - - Critical - Blocking my work - - High - Significantly improves workflow - - Medium - Nice to have - - Low - Minor improvement - validations: - required: true - - - type: textarea - id: use-case - attributes: - label: Use Case - description: Describe your use case and how this feature would benefit you or others - placeholder: | - In my project, I need to... - This would help when... - validations: - required: true - - - type: textarea - id: api-example - attributes: - label: API Example - description: If applicable, show how you envision using this feature + label: Example usage + description: Show how the API might look render: python - placeholder: | - from leann import LeannBuilder - - # How the API might look - builder = LeannBuilder() - builder.new_feature(...) - - - type: textarea - id: implementation-ideas - attributes: - label: Implementation Ideas - description: If you have ideas about how this could be implemented, share them here - placeholder: | - This could be implemented by... - We might need to modify... - - - type: dropdown - id: breaking-change - attributes: - label: Breaking Change - description: Would this feature require breaking changes to existing APIs? - options: - - "No - Fully backward compatible" - - "Yes - Would require API changes" - - "Not sure" - validations: - required: true - - - type: textarea - id: additional-context - attributes: - label: Additional Context - description: Add any other context, screenshots, or examples about the feature request - - - type: checkboxes - id: contribution - attributes: - label: Contribution - options: - - label: I am willing to help implement this feature - required: false - - label: I am willing to help test this feature - required: false - - label: I have searched existing issues and this is not a duplicate - required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 451c876..e482f32 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,84 +1,13 @@ -## ๐Ÿ“‹ Description +## What does this PR do? - + -## ๐ŸŽฏ 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 not work as expected) -- [ ] ๐Ÿ“š Documentation update -- [ ] ๐ŸŽจ Code refactoring -- [ ] โšก Performance improvement -- [ ] ๐Ÿงช Test addition/modification -- [ ] ๐Ÿ”ง Build/CI configuration change - -## ๐Ÿ”— Related Issues - - +## Related Issues Fixes # -Related to # -## โœ… Checklist +## Checklist - - -- [ ] My code follows the style guidelines of this project (ran `ruff format` and `ruff check`) -- [ ] I have performed a self-review of my own 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 in downstream modules -- [ ] I have run pre-commit hooks (`pre-commit run --all-files`) - -## ๐Ÿงช Testing - - - -### Test Configuration -- **Python version**: -- **Operating System**: - -### Test Results - - -```bash -# Add test command outputs here -``` - -## ๐Ÿ“ธ Screenshots (if applicable) - - - -## ๐Ÿ“ Additional Notes - - - -## ๐Ÿš€ Performance Impact - - - -- [ ] No performance impact -- [ ] Performance improvement (describe below) -- [ ] Potential performance regression (explain mitigation) - - - -## ๐Ÿ”„ Migration Guide (if breaking change) - - - -### Before -```python -# Old usage example -``` - -### After -```python -# New usage example -``` +- [ ] Tests pass (`uv run pytest`) +- [ ] Code formatted (`ruff format` and `ruff check`) +- [ ] Pre-commit hooks pass (`pre-commit run --all-files`)