diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..eb908d2e --- /dev/null +++ b/CONTRIBUTING.md @@ -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! diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md deleted file mode 100644 index 4316dea1..00000000 --- a/CONTRIBUTION.md +++ /dev/null @@ -1,82 +0,0 @@ -# 🚀 How to Contribute to MEMGPT - -Welcome to the fun world of contributing to MEMGPT! 🎉 Whether you're a coding wizard, a design guru, a testing enthusiast, or just brimming with awesome ideas, we're thrilled to have you on board. Here's a playful 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. It's like claiming your own slice of the project cake! - -### 🚀 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 - -Every project has its toolbox, and MEMGPT is no exception. Let's gather those fancy tools. 🔧 - -```shell -cd memgpt -npm install # or your package manager of choice -``` - -## 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. 🕵️ - -## 4. 🚀 Submitting Changes - -### 🚀 Create a Pull Request - -You're almost there! It's time to share your brilliance with the world. 🌍 - -1. Visit the MEMGPT repository on GitHub. -2. Tap that "New Pull Request" button. Think of it as ringing the doorbell to the project's house. -3. Choose the base branch (usually the project's main or development branch) and the compare branch (your feature branch). -4. Whip up a catchy title and describe your magic in the description. 🪄 - -## 5. 🔍 Review and Approval - -Your creation will be in the spotlight! 🌟 The guardians of the project, the maintainers, will take a look. They might suggest some cool upgrades or ask for more details. Once they give the thumbs up, your creation becomes part of the magic show! - -## 6. 📜 Code of Conduct - -Oh, and while you're here, follow the project's Code of Conduct. It's like the rules of the playground – be nice and play fair! 🤝 - -## 7. 📫 Contact - -Need help or just want to say hi? We're here for you. Reach out through the GitHub repository or use [email or contact details]. We're like the friendly neighbors next door. - -Thanks for making MEMGPT even more fantastic! Your contributions help turn this project into a real masterpiece! 🌈 \ No newline at end of file