Update CONTRIBUTING.md
This commit is contained in:
Vasilije
GitHub
parent
819e411149
commit
1d4d54c1f5
1 changed files with 52 additions and 59 deletions
111
CONTRIBUTING.md
111
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.
|
You can contribute to **cognee** in many ways:
|
||||||
2. In the upper-right corner, click the **'Fork'** button.
|
|
||||||
|
|
||||||
### 🚀 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
|
```shell
|
||||||
git clone https://github.com/<your-github-username>/cognee.git
|
git clone https://github.com/<your-github-username>/cognee.git
|
||||||
|
cd cognee
|
||||||
```
|
```
|
||||||
|
|
||||||
## 2. 🛠️ Making Changes
|
### Create a Branch
|
||||||
|
|
||||||
### 🌟 Create a Branch
|
|
||||||
|
|
||||||
Get ready to channel your creativity. Begin by creating a new branch for your incredible features. 🧞♂️
|
|
||||||
|
|
||||||
|
Create a new branch for your work:
|
||||||
```shell
|
```shell
|
||||||
git checkout -b feature/your-feature-name
|
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. 🌠
|
1. **Code Style**: Follow the project's coding standards
|
||||||
|
2. **Documentation**: Update relevant documentation
|
||||||
## 3. 🚀 Submitting Changes
|
3. **Tests**: Add tests for new features
|
||||||
|
4. **Commits**: Write clear commit messages
|
||||||
After making your changes, follow these steps:
|
|
||||||
|
|
||||||
### ✅ Run the Tests
|
|
||||||
|
|
||||||
Ensure your changes do not break the existing codebase:
|
|
||||||
|
|
||||||
|
### Running Tests
|
||||||
```shell
|
```shell
|
||||||
python cognee/cognee/tests/test_library.py
|
python cognee/cognee/tests/test_library.py
|
||||||
```
|
```
|
||||||
|
|
||||||
### 🚢 Push Your Feature Branch
|
## 4. 📤 Submitting Changes
|
||||||
|
|
||||||
|
1. Push your changes:
|
||||||
```shell
|
```shell
|
||||||
# Add your changes to the staging area:
|
|
||||||
git add .
|
git add .
|
||||||
|
git commit -s -m "Description of your changes"
|
||||||
# Commit changes with an adequate description:
|
|
||||||
git commit -m "Describe your changes here"
|
|
||||||
|
|
||||||
# Push your feature branch to your forked repository:
|
|
||||||
git push origin feature/your-feature-name
|
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.
|
All contributions must be signed-off to indicate agreement with our DCO:
|
||||||
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. 🎩
|
|
||||||
|
|
||||||
## 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
|
- Be respectful and inclusive
|
||||||
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:
|
- 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:
|
Thank you for contributing to **cognee**! 🌟
|
||||||
'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**!
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue