Skip to content

Latest commit

 

History

History
156 lines (113 loc) · 4.97 KB

CONTRIBUTING.md

File metadata and controls

156 lines (113 loc) · 4.97 KB

Important

Note for contributors: When branching out, create a new branch from the dev branch.

🎉 Welcome to cognee!

We're excited that you're interested in contributing to our project! We want to ensure that every user and contributor feels welcome, included and supported to participate in cognee community. 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

📫 Get in Touch

There are several ways to connect with the cognee team and community:

GitHub Collaboration

  • Open an issue for bug reports, feature requests, or discussions
  • Submit pull requests to contribute code or documentation
  • Join ongoing discussions in existing issues and PRs

Community Channels

  • Join our Discord community for real-time discussions
  • Participate in community events and discussions
  • Get help from other community members

Direct Contact

  • Email: vasilije@cognee.ai
  • For business inquiries or sensitive matters, please reach out via email
  • For general questions, prefer public channels like GitHub issues or Discord

We aim to respond to all communications within 2 business days. For faster responses, consider using our Discord channel where the whole community can help!

Issue Labels

To help you find the most appropriate issues to work on, we use the following labels:

  • good first issue - Perfect for newcomers to the project
  • bug - Something isn't working as expected
  • documentation - Improvements or additions to documentation
  • enhancement - New features or improvements
  • help wanted - Extra attention or assistance needed
  • question - Further information is requested
  • wontfix - This will not be worked on

Looking for a place to start? Try filtering for good first issues!

2. 🛠️ Development Setup

Fork and Clone

  1. Fork the cognee repository
  2. Clone your fork:
git clone https://github.com/<your-github-username>/cognee.git
cd cognee

In case you are working on Vector and Graph Adapters

  1. Fork the cognee-community repository
  2. Clone your fork:
git clone https://github.com/<your-github-username>/cognee-community.git
cd cognee-community

Create a Branch

Create a new branch for your work:

git checkout -b feature/your-feature-name

3. 🎯 Making Changes

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

Running Tests

python cognee/cognee/tests/test_library.py

Running Simple Example

Change .env.example into .env and provide your OPENAI_API_KEY as LLM_API_KEY

Make sure to run shell uv sync in the root cloned folder or set up a virtual environment to run cognee

python cognee/cognee/examples/python/simple_example.py

or

uv run python cognee/cognee/examples/python/simple_example.py

4. 📤 Submitting Changes

  1. Install ruff on your system
  2. Run ruff format . and ruff check and fix the issues
  3. Push your changes:
git add .
git commit -s -m "Description of your changes"
git push origin feature/your-feature-name
  1. Create a Pull Request:

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! 🌟