gmakstutis/cognee
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated CONTRIBUTING.md

Browse source
This commit is contained in:
vujke 2024-05-30 14:15:46 +02:00
parent 9f3e6eb49c
commit ba1e24449f
1 changed files with 57 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

89
CONTRIBUTING.md
View file

@ -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/<your-github-username>/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**!