Update and rename CONTRIBUTION.md to CONTRIBUTING.md

This commit is contained in:
Vivian Fang
2023-10-18 11:18:12 -07:00
committed by GitHub
parent 53cac54440
commit 64d48af6d7
2 changed files with 89 additions and 82 deletions

89
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,89 @@
# 🚀 How to Contribute to MemGPT
Thank you for investing time in contributing to our project! Here's a guide to get you started.
## 📋 Table of Contents
1. [🚀 Getting Started](#getting-started)
2. [🛠️ Making Changes](#making-changes)
3. [✅ Testing](#testing)
4. [🚀 Submitting Changes](#submitting-changes)
5. [🔍 Review and Approval](#review-and-approval)
6. [📜 Code of Conduct](#code-of-conduct)
7. [📫 Contact](#contact)
## 1. 🚀 Getting Started
### 🍴 Fork the Repository
First things first, let's get you a personal copy of MemGPT to play with. Think of it as your very own playground. 🎪
1. Head over to the MemGPT repository on GitHub.
2. In the upper-right corner, hit the 'Fork' button.
### 🚀 Clone the Repository
Now, let's bring your new playground to your local machine.
```shell
git clone https://github.com/your-username/MemGPT.git
```
### 🧩 Install Dependencies
```shell
cd MemGPT
# Optional: set up a virtual environment.
# python3 -m venv venv
# . venv/bin/activate
pip install -r requirements.txt
```
## 2. 🛠️ Making Changes
### 🌟 Create a Branch
Time to put on your creative hat and make some magic happen. First, let's create a new branch for your awesome changes. 🧙‍♂️
```shell
git checkout -b feature/your-feature
```
### ✏️ Make your Changes
Now, the world is your oyster! Go ahead and craft your fabulous changes. 🎨
## 3. ✅ Testing
Before we hit the 'Wow, I'm Done' button, let's make sure everything works as expected. Run tests and make sure the existing ones don't throw a fit. And if needed, create new tests. 🕵️
Make sure that you can run
```shell
python3 main.py
```
successfully before submitting a pull request.
## 4. 🚀 Submitting Changes
### 🚀 Create a Pull Request
You're almost there! It's time to share your brilliance with the world. 🌍
1. Visit [MemGPT](https://github.com/cpacker/memgpt).
2. Click "New Pull Request" button.
3. Choose the base branch (`main`) and the compare branch (your feature branch).
4. Whip up a catchy title and describe your changes in the description. 🪄
## 5. 🔍 Review and Approval
The maintainers, will take a look and might suggest some cool upgrades or ask for more details. Once they give the thumbs up, your creation becomes part of MemGPT!
## 6. 📜 Code of Conduct
Please be sure to follow the project's Code of Conduct.
## 7. 📫 Contact
Need help or just want to say hi? We're here for you. Reach out through filing an issue on this GitHub repository or message us on our [Discord server](https://discord.gg/9GEQrxmVyE).
Thanks for making MemGPT even more fantastic!