🎉 Welcome to cognee!

We're excited that you're interested in contributing to our project! This guide will help you get started and ensure your contributions can be efficiently integrated into the project.

🌟 Quick Links

1. 🚀 Ways to Contribute

You can contribute to cognee in many ways:

📝 Submitting bug reports or feature requests
💡 Improving documentation
🔍 Reviewing pull requests
🛠️ Contributing code or tests
🌐 Helping other users

2. 🛠️ Development Setup

Fork and Clone

Fork the cognee repository
Clone your fork:

git clone https://github.com/<your-github-username>/cognee.git
cd cognee

Create a Branch

Create a new branch for your work:

git checkout -b feature/your-feature-name

3. 🎯 Making Changes

Code Style: Follow the project's coding standards
Documentation: Update relevant documentation
Tests: Add tests for new features
Commits: Write clear commit messages

Running Tests

python cognee/cognee/tests/test_library.py

4. 📤 Submitting Changes

Push your changes:

git add .
git commit -s -m "Description of your changes"
git push origin feature/your-feature-name

Create a Pull Request:
- Go to the cognee repository
- Click "Compare & Pull Request"
- Fill in the PR template with details about your changes

5. 📜 Developer Certificate of Origin (DCO)

All contributions must be signed-off to indicate agreement with our DCO:

git config alias.cos "commit -s"  # Create alias for signed commits

When your PR is ready, please include:

"I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin"

6. 🤝 Community Guidelines

Be respectful and inclusive
Help others learn and grow
Follow our Code of Conduct
Provide constructive feedback
Ask questions when unsure

7. 📫 Getting Help

Open an issue
Join our Discord community
Check existing documentation

Thank you for contributing to cognee! 🌟

2.4 KiB Raw Blame History