61 lines
2.1 KiB
Markdown
61 lines
2.1 KiB
Markdown
# 🚀 How to Contribute to PromethAI Memory
|
|
|
|
Thank you for investing time in contributing to our project! Here's a guide to get you started.
|
|
|
|
## 1. 🚀 Getting Started
|
|
|
|
### 🍴 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. 🧪
|
|
|
|
1. Navigate to the PromethAI Memory 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
|
|
```
|
|
|
|
|
|
## 2. 🛠️ Making Changes
|
|
🌟 Create a Branch
|
|
Get ready to channel your creativity. Begin by creating a new branch for your incredible features. 🧞♂️
|
|
|
|
|
|
Copy code
|
|
git checkout -b feature/your-feature-name
|
|
✏️ Make Your Changes
|
|
Now's your chance to shine! Dive in and make your contributions. 🌠
|
|
|
|
|
|
## 3. 🚀 Submitting Changes
|
|
🚀 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!
|
|
|
|
6. 📜 Code of Conduct
|
|
Ensure you adhere to the project's Code of Conduct 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 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.
|
|
|
|
|
|
|
|
|