Create CONTRIBUTING.md (#91)

AI-Citizen · Oct 31, 2023 · b2d8351 · b2d8351
1 parent 5618b0a
commit b2d8351
Showing 1 changed file with 67 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,67 @@
+# Contributing to SolidGPT
+
+Welcome to the world of SolidGPT – where magic meets AI! ✨ Your contributions can help shape the future of language models. 🚀
+I hope you'd find this guide amazing and friendly for you, yes, magically! 🔥
+
+## 🌟 Getting Started
+
+1. **Fork the Repository** 🍴
+   - Begin your journey by clicking the "Fork" button in the top right corner. This creates your very own copy of the repository in your GitHub haven.
+
+2. **Clone Your Magical Fork** 📦
+   - Open your command center and run: `git clone https://github.com/your-username/SolidGPT.git`
+
+3. **Create a Virtual Realm** 🪄
+   - Forge a virtual realm to harness your powers (virtual environment, that is).
+
+4. **Summon Dependencies** 🧙‍♂️
+   - Navigate to the project realm and conjure the required potions (install the dependencies):
+   ```
+   cd SolidGPT
+   pip install -r requirements.txt
+   ```
+
+## 🧙‍♂️ Making Enchantments
+
+5. **Craft a Spellbinding Branch** 🌱
+   - Weave your enchantments in a new branch:
+   ```
+   git checkout -b my-magical-feature
+   ```
+
+6. **Enchant the Code** 📜
+   - Work your magic on the code, keeping our spellbinding code style guidelines in mind. You can find them in the `CONTRIBUTING_GUIDELINES.md`.
+
+7. **Test Your Spells** 🧙‍♀️
+   - Ensure your spells are well-tested. Cast the test incantations with:
+   ```
+   pytest
+   ```
+
+## ✨ Unleash Your Powers
+
+8. **Seal Your Enchantments** 📝
+   - Seal your enchantments with a scroll of a commit message:
+   ```
+   git commit -m "Enchant the world with my magic"
+   ```
+
+9. **Unleash Your Magic** 🪄
+   - Unleash your magic upon your GitHub realm:
+   ```
+   git push origin my-magical-feature
+   ```
+
+10. **Summon a Portal** 🌀
+    - Open a portal to the realm of Pull Requests by clicking "New Pull Request" on your GitHub spellbook. Fill in the details, and we shall review your magic!
+
+## 💬 Share Your Secrets
+
+11. **Share Your Enchantment Ideas** 💡
+    - If you've discovered a new incantation, share it by opening an issue in our GitHub grimoire!
+
+## 🪄 Thank You for Unveiling Your Magic!
+
+Your contributions are a treasure trove of magic for SolidGPT! We are enchanted by your presence and grateful for your enchantments. 🙌
+
+Now, off you go, magician of code – fork, cast your spells, and may your contributions always be enchanting! 🪄✨