Skip to content

armgit / LEANN

Public Imported from GitHub
0

[MLsys2026 Best Paper]: https://arxiv.org/abs/2506.08276. RAG on Everything with LEANN. Enjoy 97% storage savings while running a fast, accurate, and 100% private RAG application on your personal device.

feat: Add GitHub PR and issue templates (#105)

Andy Leead0d2faabc2e
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..b18bb62
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,50 @@
+name: Bug Report
+description: Report a bug in LEANN
+labels: ["bug"]
+
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: What happened?
+ description: A clear description of the bug
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduce
+ attributes:
+ label: How to reproduce
+ placeholder: |
+ 1. Install with...
+ 2. Run command...
+ 3. See error
+ validations:
+ required: true
+
+ - type: textarea
+ id: error
+ attributes:
+ label: Error message
+ description: Paste any error messages
+ render: shell
+
+ - type: input
+ id: version
+ attributes:
+ label: LEANN Version
+ placeholder: "0.1.0"
+ validations:
+ required: true
+
+ - type: dropdown
+ id: os
+ attributes:
+ label: Operating System
+ options:
+ - macOS
+ - Linux
+ - Windows
+ - Docker
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..ce0f898
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Documentation
+ url: https://github.com/LEANN-RAG/LEANN-RAG/tree/main/docs
+ about: Read the docs first
+ - name: Discussions
+ url: https://github.com/LEANN-RAG/LEANN-RAG/discussions
+ about: Ask questions and share ideas
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..0b01b1d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,27 @@
+name: Feature Request
+description: Suggest a new feature for LEANN
+labels: ["enhancement"]
+
+body:
+ - type: textarea
+ id: problem
+ attributes:
+ label: What problem does this solve?
+ description: Describe the problem or need
+ validations:
+ required: true
+
+ - type: textarea
+ id: solution
+ attributes:
+ label: Proposed solution
+ description: How would you like this to work?
+ validations:
+ required: true
+
+ - type: textarea
+ id: example
+ attributes:
+ label: Example usage
+ description: Show how the API might look
+ render: python
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..e482f32
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,13 @@
+## What does this PR do?
+
+<!-- Brief description of your changes -->
+
+## Related Issues
+
+Fixes #
+
+## Checklist
+
+- [ ] Tests pass (`uv run pytest`)
+- [ ] Code formatted (`ruff format` and `ruff check`)
+- [ ] Pre-commit hooks pass (`pre-commit run --all-files`)