diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96f41f48e..d9ba4039f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# ๐Ÿš€ How to Contribute to PromethAI Memory +# ๐Ÿš€ How to Contribute to **cognee** Thank you for investing time in contributing to our project! Here's a guide to get you started. @@ -6,56 +6,81 @@ Thank you for investing time in contributing to our project! Here's a guide to g ### ๐Ÿด Fork the Repository -To start your journey, you'll need your very own copy of PromethAI Memory. Think of it as your own innovation lab. ๐Ÿงช +To start your journey, you'll need your very own copy of **cognee**. Think of it as your own innovation lab. ๐Ÿงช -1. Navigate to the PromethAI Memory repository on GitHub. -2. In the upper-right corner, click the 'Fork' button. +1. Navigate to the [**cognee**](https://github.com/topoteretes/cognee) repository on GitHub. +2. In the upper-right corner, `click the 'Fork'` button. ### ๐Ÿš€ Clone the Repository Next, let's bring your newly forked repository to your local machine. -``` -shell -git clone https://github.com/topoteretes/PromethAI-Memory.git +```shell +git clone https://github.com//cognee.git ``` +## 2. ๐Ÿ› ๏ธ Making Changes + +### ๐ŸŒŸ Create a Branch -## 2. ๐Ÿ› ๏ธ Making Changes -๐ŸŒŸ Create a Branch Get ready to channel your creativity. Begin by creating a new branch for your incredible features. ๐Ÿงžโ€โ™‚๏ธ - -Copy code +```shell git checkout -b feature/your-feature-name -โœ๏ธ Make Your Changes +``` + +### โœ๏ธ Make Your Changes + Now's your chance to shine! Dive in and make your contributions. ๐ŸŒ  - ## 3. ๐Ÿš€ Submitting Changes -๐Ÿš€ Create a Pull Request + +After making your changes, follow these steps + +### โœ… Run the tests + + to ensure your changes do not break the existing codebase: + +```shell +python cognee/cognee/tests/test_library.py +``` + + +### ๐Ÿšข Push your feature branch + +```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: + +Copy code +git push origin feature/your-feature-name +``` + +### ๐Ÿš€ Create a Pull Request + You're on the verge of completion! It's time to showcase your hard work. ๐ŸŒ -Go to PromethAI Memory on GitHub. -Hit the "New Pull Request" button. -Select the base branch (main) and the compare branch (the one with your features). -Craft a compelling title and provide a detailed description of your contributions. ๐ŸŽฉ -5. ๐Ÿ” Review and Approval -The project maintainers will review your work, possibly suggest improvements, or request further details. Once you receive approval, your contributions will become part of PromethAI Memory! +1. Go to [**cognee**](https://github.com/topoteretes/cognee) on GitHub. +2. Hit the `"New 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. ๐ŸŽฉ + +## 4. ๐Ÿ” Review and Approval + +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**! + +## 5. ๐Ÿ“œ Code of Conduct -6. ๐Ÿ“œ Code of Conduct Ensure you adhere to the project's Code of Conduct throughout your participation. -7. ๐Ÿ“ซ Contact +## 6. ๐Ÿ“ซ 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 PromethAI Memory! - -arduino -Copy code - -Be sure to replace `https://github.com/your-username/PromethAI-Memory.git` with the actual URL of your forked repository and `https://github.com/cpacker/promethai-memory` with the actual URL of the main repository, and also update the Discord invite link to the correct one for PromethAI Memory. - - - - +Thanks for helping to evolve **cognee**!