my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	# Contributing to mem0
#2
#3	Let us make contribution easy, collaborative and fun.
#4
#5	## Submit your Contribution through PR
#6
#7	To make a contribution, follow these steps:
#8
#9	1. Fork and clone this repository
#10	2. Do the changes on your fork with dedicated feature branch `feature/f1`
#11	3. If you modified the code (new feature or bug-fix), please add tests for it
#12	4. Include proper documentation / docstring and examples to run the feature
#13	5. Ensure that all tests pass
#14	6. Submit a pull request
#15
#16	For more details about pull requests, please read [GitHub's guides](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
#17
#18
#19	### 📦 Development Environment
#20
#21	We use `hatch` for managing development environments. To set up:
#22
#23	```bash
#24	# Activate environment for specific Python version:
#25	hatch shell dev_py_3_9 # Python 3.9
#26	hatch shell dev_py_3_10 # Python 3.10
#27	hatch shell dev_py_3_11 # Python 3.11
#28	hatch shell dev_py_3_12 # Python 3.12
#29
#30	# The environment will automatically install all dev dependencies
#31	# Run tests within the activated shell:
#32	make test
#33	```
#34
#35	### 📌 Pre-commit
#36
#37	To ensure our standards, make sure to install pre-commit before starting to contribute.
#38
#39	```bash
#40	pre-commit install
#41	```
#42
#43	### 🧪 Testing
#44
#45	We use `pytest` to test our code across multiple Python versions. You can run tests using:
#46
#47	```bash
#48	# Run tests with default Python version
#49	make test
#50
#51	# Test specific Python versions:
#52	make test-py-3.9 # Python 3.9 environment
#53	make test-py-3.10 # Python 3.10 environment
#54	make test-py-3.11 # Python 3.11 environment
#55	make test-py-3.12 # Python 3.12 environment
#56
#57	# When using hatch shells, run tests with:
#58	make test # After activating a shell with hatch shell test_XX
#59	```
#60
#61	Make sure that all tests pass across all supported Python versions before submitting a pull request.
#62
#63	We look forward to your pull requests and can't wait to see your contributions!
#64

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public