Skip to content

armgit / mem0

Public Imported from GitHub
0

The Memory Layer for AI Agents - Drop-in memory infrastructure for AI agents and apps. Context that persists. Built for production.

Add contributing doc (#1794)

Dev Khant851b665c1105
diff --git a/docs/open-source/quickstart.mdx b/docs/open-source/quickstart.mdx
index 1e3ba11c3..fb414001a 100644
--- a/docs/open-source/quickstart.mdx
+++ b/docs/open-source/quickstart.mdx
@@ -330,6 +330,40 @@ history = client.history(memory_id="m1")
print(history)
```
+
+## Contributing
+
+We welcome contributions to Mem0! Here's how you can contribute:
+
+1. Fork the repository and create your branch from `main`.
+2. Clone the forked repository to your local machine.
+3. Install the project dependencies:
+
+ ```bash
+ poetry install
+ ```
+
+4. Install pre-commit hooks:
+
+ ```bash
+ pip install pre-commit # If pre-commit is not already installed
+ pre-commit install
+ ```
+
+5. Make your changes and ensure they adhere to the project's coding standards.
+
+6. Run the tests locally:
+
+ ```bash
+ poetry run pytest
+ ```
+
+7. If all tests pass, commit your changes and push to your fork.
+8. Open a pull request with a clear title and description.
+
+Please make sure your code follows our coding conventions and is well-documented. We appreciate your contributions to make Mem0 better!
+
+
If you have any questions, please feel free to reach out to us using one of the following methods:
<Snippet file="get-help.mdx" />