JDSS/mem0
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add issue templates for bug, feature, benchmark, documentation, and update contact links (#4500)

Browse Source
This commit is contained in:
Kartik
2026-03-23 15:37:23 +05:30
committed by GitHub
parent ecedbc11d9
commit c5e8216362
6 changed files with 294 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/benchmark_submission.yml
+88
View File
@@ -0,0 +1,88 @@
name: Benchmark Submission
description: Submit evaluation or benchmark results for a model configuration
labels: ["benchmark"]
body:
- type: markdown
attributes:
value: |
Share your benchmark results to help the community compare model configurations. Please include enough detail for others to reproduce your results.
- type: input
id: model-name
attributes:
label: Model name
description: The LLM used for memory extraction.
placeholder: "e.g., gpt-4o, claude-3.5-sonnet, llama-3.1-70b"
validations:
required: true
- type: textarea
id: model-config
attributes:
label: Model configuration
description: |
Paste your mem0 config (redact any API keys).
placeholder: |
```python
config = {
"llm": {
"provider": "openai",
"config": {
"model": "gpt-4o",
"temperature": 0.0,
}
},
"vector_store": {
"provider": "qdrant",
"config": {
"collection_name": "benchmark",
"embedding_model_dims": 1536,
}
}
}
```
validations:
required: true
- type: input
id: dataset
attributes:
label: Dataset / eval suite
description: Which dataset or evaluation suite did you use?
placeholder: "e.g., LOCOMO, custom dataset (link), internal eval"
validations:
required: true
- type: textarea
id: results
attributes:
label: Results
description: |
Paste your results. Use a markdown table if comparing multiple configs.
placeholder: |
| Metric | Score |
|--------------|--------|
| Precision | 0.85 |
| Recall | 0.78 |
| F1 | 0.81 |
| Latency (ms) | 120 |
validations:
required: true
- type: textarea
id: hardware
attributes:
label: Hardware / environment
description: What hardware did you run this on?
placeholder: "e.g., M2 MacBook Pro 16GB, AWS g5.xlarge, local RTX 4090"
validations:
required: false
- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: How can someone reproduce these results?
validations:
required: false
.github/ISSUE_TEMPLATE/bug_report.yml
+95 -32
View File
@@ -1,41 +1,104 @@
name: 🐛 Bug Report
description: Create a report to help us reproduce and fix the bug
name: Bug Report
description: Report a bug to help us fix it
labels: ["bug"]
body:
- type: markdown
attributes:
value: >
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/embedchain/embedchain/issues?q=is%3Aissue+sort%3Acreated-desc+).
- type: textarea
attributes:
label: 🐛 Describe the bug
description: |
Please provide a clear and concise description of what the bug is.
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please search [existing issues](https://github.com/mem0ai/mem0/issues?q=is%3Aissue) first to avoid duplicates.
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc. For example:
- type: dropdown
id: component
attributes:
label: Component
description: Which part of mem0 is affected?
options:
- Core / Python SDK
- TypeScript SDK
- Vector Store (Qdrant, PGVector, Redis, Chroma, etc.)
- Graph Memory (Neo4j, Memgraph, etc.)
- Ollama / Local Models
- OpenMemory (MCP Server)
- OpenClaw
- REST API
- Other
validations:
required: true
```python
# All necessary imports at the beginning
import embedchain as ec
# Your code goes here
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: What happened?
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: |
Provide a minimal code example or steps to reproduce the bug. We will copy-paste your code, so keep it self-contained.
placeholder: |
```python
from mem0 import Memory
```
m = Memory()
# Steps that trigger the bug...
```
validations:
required: true
Please also paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
placeholder: |
A clear and concise description of what the bug is.
- type: textarea
id: expected
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true
```python
Sample code to reproduce the problem
```
- type: textarea
id: actual
attributes:
label: Actual behavior
description: What actually happened? Include the full error traceback if applicable.
placeholder: |
Paste error output here, including the full traceback.
validations:
required: true
```
The error message you got, with the full traceback.
````
validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
- type: input
id: mem0-version
attributes:
label: mem0 version
description: "Run `pip show mem0ai` or check your package.json"
placeholder: "e.g., 0.1.29"
validations:
required: true
- type: input
id: python-version
attributes:
label: Python / Node.js version
description: "Run `python --version` or `node --version`"
placeholder: "e.g., Python 3.11.5 or Node 20.10.0"
validations:
required: true
- type: input
id: os
attributes:
label: Operating system
placeholder: "e.g., macOS 14.2, Ubuntu 22.04, Windows 11"
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: Any other context — config files, environment variables, related issues, etc.
validations:
required: false
.github/ISSUE_TEMPLATE/config.yml
+5 -5
View File
@@ -1,8 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: 1-on-1 Session
url: https://cal.com/taranjeetio/ec
about: Speak directly with Taranjeet, the founder, to discuss issues, share feedback, or explore improvements for Embedchain
- name: Discord
- name: Discord Community
url: https://discord.gg/6PzXDgEjG5
about: General community discussions
about: Ask questions and discuss with the community
- name: Documentation
url: https://docs.mem0.ai
about: Read the official mem0 documentation
.github/ISSUE_TEMPLATE/documentation_issue.yml
+21 -9
View File
@@ -1,11 +1,23 @@
name: Documentation
description: Report an issue related to the Embedchain docs.
title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
name: Documentation Issue
description: Report an issue or suggest an improvement to the mem0 docs
labels: ["documentation"]
title: "DOC: "
body:
- type: textarea
attributes:
label: "Issue with current documentation:"
description: >
Please make sure to leave a reference to the document/code you're
referring to.
- type: textarea
id: description
attributes:
label: Issue with current documentation
description: |
Describe what's wrong or missing. Please link to the specific page or section.
placeholder: "https://docs.mem0.ai/... — this section is missing X / incorrect about Y"
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested fix
description: How should the docs be improved?
validations:
required: false
.github/ISSUE_TEMPLATE/feature_request.yml
+60 -21
View File
@@ -1,23 +1,62 @@
name: 🚀 Feature request
description: Submit a proposal/request for a new Embedchain feature
name: Feature Request
description: Suggest a new feature or improvement for mem0
labels: ["enhancement"]
body:
- type: textarea
id: feature-request
attributes:
label: 🚀 The feature
description: >
A clear and concise description of the feature proposal
validations:
required: true
- type: textarea
attributes:
label: Motivation, pitch
description: >
Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too.
validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! Please search [existing issues](https://github.com/mem0ai/mem0/issues?q=is%3Aissue+label%3Aenhancement) first to avoid duplicates.
- type: dropdown
id: component
attributes:
label: Component
description: Which part of mem0 does this relate to?
options:
- Core / Python SDK
- TypeScript SDK
- Vector Store (Qdrant, PGVector, Redis, Chroma, etc.)
- Graph Memory (Neo4j, Memgraph, etc.)
- Ollama / Local Models
- OpenMemory (MCP Server)
- OpenClaw
- REST API
- Benchmarks / Evals
- Other
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use case
description: |
What problem are you trying to solve? Describe the situation where you need this feature.
placeholder: "I'm building X and need Y because..."
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: Proposed solution
description: How do you think this should work? Include API examples or pseudocode if helpful.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Have you tried any workarounds? Are there other approaches you've considered?
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: Any other context, screenshots, or references.
validations:
required: false
.github/PULL_REQUEST_TEMPLATE.md
+25 -28
View File
@@ -1,41 +1,38 @@
## Linked Issue
Closes #<!-- issue number -->
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
<!-- What does this PR do? Why is it needed? -->
Fixes # (issue)
## Type of Change
## Type of change
Please delete options that are not relevant.
- [ ] 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)
- [ ] Refactor (does not change functionality, e.g. code style improvements, linting)
- [ ] 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)
- [ ] Refactor (no functional changes)
- [ ] Documentation update
## How Has This Been Tested?
## Breaking Changes
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
<!-- If this is a breaking change, describe what breaks and the migration path. Delete this section if not applicable. -->
Please delete options that are not relevant.
N/A
- [ ] Unit Test
- [ ] Test Script (please provide)
## Test Coverage
## Checklist:
- [ ] I added/updated unit tests
- [ ] I added/updated integration tests
- [ ] I tested manually (describe below)
- [ ] No tests needed (explain why)
- [ ] My code follows the style guidelines of this project
- [ ] 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 checked my code and corrected any misspellings
<!-- Describe how you tested this, or link to CI results. -->
## Maintainer Checklist
## Checklist
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number)
- [ ] Made sure Checks passed
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have added tests that prove my fix/feature works
- [ ] New and existing tests pass locally
- [ ] I have updated documentation if needed