diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba9c3df25..734ae62fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,97 +1,90 @@ -# ๐Ÿš€ How to Contribute to **cognee** +# ๐ŸŽ‰ Welcome to **cognee**! -Thank you for investing time in contributing to our project! Here's a guide to get you started. +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. -## 1. ๐Ÿš€ Getting Started +## ๐ŸŒŸ Quick Links -### ๐Ÿด Fork the Repository +- [Code of Conduct](CODE_OF_CONDUCT.md) +- [Discord Community](https://discord.gg/bcy8xFAtfd) +- [Issue Tracker](https://github.com/topoteretes/cognee/issues) -To start your journey, you'll need your very own copy of **cognee**. Think of it as your own innovation lab. ๐Ÿงช +## 1. ๐Ÿš€ Ways to Contribute -1. Navigate to the [**cognee**](https://github.com/topoteretes/cognee) repository on GitHub. -2. In the upper-right corner, click the **'Fork'** button. +You can contribute to **cognee** in many ways: -### ๐Ÿš€ Clone the Repository +- ๐Ÿ“ Submitting bug reports or feature requests +- ๐Ÿ’ก Improving documentation +- ๐Ÿ” Reviewing pull requests +- ๐Ÿ› ๏ธ Contributing code or tests +- ๐ŸŒ Helping other users -Next, let's bring your newly forked repository to your local machine. +## 2. ๐Ÿ› ๏ธ Development Setup +### Fork and Clone + +1. Fork the [**cognee**](https://github.com/topoteretes/cognee) repository +2. Clone your fork: ```shell git clone https://github.com//cognee.git +cd cognee ``` -## 2. ๐Ÿ› ๏ธ Making Changes - -### ๐ŸŒŸ Create a Branch - -Get ready to channel your creativity. Begin by creating a new branch for your incredible features. ๐Ÿงžโ€โ™‚๏ธ +### Create a Branch +Create a new branch for your work: ```shell git checkout -b feature/your-feature-name ``` -### โœ๏ธ Make Your Changes +## 3. ๐ŸŽฏ Making Changes -Now's your chance to shine! Dive in and make your contributions. ๐ŸŒ  - -## 3. ๐Ÿš€ Submitting Changes - -After making your changes, follow these steps: - -### โœ… Run the Tests - -Ensure your changes do not break the existing codebase: +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 ```shell python cognee/cognee/tests/test_library.py ``` -### ๐Ÿšข Push Your Feature Branch +## 4. ๐Ÿ“ค Submitting Changes +1. Push your changes: ```shell -# Add your changes to the staging area: git add . - -# Commit changes with an adequate description: -git commit -m "Describe your changes here" - -# Push your feature branch to your forked repository: +git commit -s -m "Description of your changes" git push origin feature/your-feature-name ``` -### ๐Ÿš€ Create a Pull Request +2. Create a Pull Request: + - Go to the [**cognee** repository](https://github.com/topoteretes/cognee) + - Click "Compare & Pull Request" + - Fill in the PR template with details about your changes -You're on the verge of completion! It's time to showcase your hard work. ๐ŸŒ +## 5. ๐Ÿ“œ Developer Certificate of Origin (DCO) -1. Go to [**cognee**](https://github.com/topoteretes/cognee) on GitHub. -2. Hit the **"Compare & Pull Request"** button. -3. Select the base branch (main) and the compare branch (the one with your features). -4. Craft a **compelling title** and provide a **detailed description** of your contributions. ๐ŸŽฉ +All contributions must be signed-off to indicate agreement with our DCO: -## 4. ๐Ÿ” Review and Approval +```shell +git config alias.cos "commit -s" # Create alias for signed commits +``` -The project maintainers will review your work, possibly suggest improvements, or request further details. Once you receive approval, your contributions will become part of **cognee**! +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 -## 5. Developer Certificate of Origin -All contributions to the topoteretes codebase must be signed-off to indicate you have read and agreed to the Developer Certificate of Origin (DCO), which is in the root directory under name DCO. To sign the DCO, simply add -s after all commits that you make, to do this easily you can make a git alias from the command line, for example: +- Be respectful and inclusive +- Help others learn and grow +- Follow our [Code of Conduct](CODE_OF_CONDUCT.md) +- Provide constructive feedback +- Ask questions when unsure -$ git config alias.cos "commit -s" +## 7. ๐Ÿ“ซ Getting Help -Will allow you to write git cos which will automatically sign-off your commit. By signing a commit you are agreeing to the DCO and agree that you will be banned from the topoteretes GitHub organisation and Discord server if you violate the DCO. +- Open an [issue](https://github.com/topoteretes/cognee/issues) +- Join our Discord community +- Check existing documentation -"When a commit is ready to be merged please use the following template to agree to our developer certificate of origin: - 'I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin' - -We consider the following as violations to the DCO: - -Signing the DCO with a fake name or pseudonym, if you are registered on GitHub or another platform with a fake name then you will not be able to contribute to topoteretes before updating your name; -Submitting a contribution that you did not have the right to submit whether due to licensing, copyright, or any other restrictions. - -## 6. ๐Ÿ“œ Code of Conduct -Ensure you adhere to the project's [Code of Conduct](https://github.com/topoteretes/cognee/blob/main/CODE_OF_CONDUCT.md) throughout your participation. - -## 7. ๐Ÿ“ซ Contact - -If you need assistance or simply wish to connect, we're here for you. Contact us by filing an issue on the GitHub repository or by messaging us on our Discord server. - -Thanks for helping to evolve **cognee**! +Thank you for contributing to **cognee**! ๐ŸŒŸ