🔀 Add a contribution guide (#14)

* 📝 Add a contribution guide

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to bun-bagel 🥯
+
+👋 Thanks for considering contributing to bun-bagel! Your help in enhancing this library is greatly appreciated.
+
+## Getting Started 🚀
+
+1. **Fork the repository:** Click the "Fork" button 🍴 at the top right of the repository page. This creates your own copy of the repository.
+2. **Clone your fork:** `git clone https://github.com/<your-username>/bun-bagel.git`
+3. **Create a branch:** `git checkout -b feature/your-feature-name` or `git checkout -b bugfix/your-bugfix-name` 🌿
+4. **Install dependencies:** `bun install`
+6. **Make your changes:** Implement your feature or fix the bug 🛠️
+5. **Run tests:** `bun test`
+7. **Commit your changes:** `git commit -m ":<gitmoji>: <your commit message>"` 📝
+8. **Push to your fork:** `git push origin feature/your-feature-name` or `git push origin bugfix/your-bugfix-name` 🚀
+9. **Create a pull request:** Go to the original repository and click the "New pull request" button. Select your fork and branch, then provide a clear description of your changes. 🎉
+
+## Coding Style 🎨
+
+**Coming soon!**
+
+## Code Review 🔍
+
+* We use GitHub's pull request system for code review.
+* Please be patient and respectful during the review process.
+* We'll try our best to provide constructive feedback and help you improve your code.
+* We'll also be happy to answer any questions you have about the codebase.
+* We'll merge your pull request once it's been reviewed and approved.
+
+
+## Commit Messages 📝
+
+We use emoji's based on Gitmoji guidelines to enhance the expressiveness of our commit messages, making them more informative and easier for contributors to understand.
+We use the following format for commit messages:
+
+```
+:<gitmoji>: This commit will... <your commit message>
+```
+
+**Examples:**
+
+* `:bug: Fix a bug that caused the app to crash`
+* `:sparkles: Add a super cool animation for the button component`
+* `:recycle: Refactor footer component`
+* `:fire: Remove deprecated code`
+* `:package: Install bun-bagel@latest`
+
+You can find a list of available gitmojis on [gitmoji.dev](https://gitmoji.dev/).
+It might be difficult at times to pick the right emoji, but please don't stress, follow your gut feeling.
+
+> [!NOTE]
+> Notice that the commit message usually completes the sentence "This commit will...".
+
+## Reporting Issues 🐛
+
+If you find a bug or have a feature request, please open an issue on the [issue tracker](https://github.com/DRFR0ST/bun-bagel/issues).
+
+## Additional Notes 📌
+
+* Please ensure your code passes all tests before submitting a pull request. ✅
+* If you're unsure about anything, feel free to ask questions in your pull request or open an issue. ❓
+
+Let's build something great together! 🥯

README.md

@@ -119,8 +119,28 @@ console.log(response.status); // => 404
 console.log(response.headers); // => { "x-foo-bar": "baz" }
 ```
 
+## 🤝 Contributing
+
+Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for details.
+
+## 🔨 Development
+
+To contribute to bun-bagel, follow these steps:
+
+1. Clone the repository: `git clone https://github.com/DRFR0ST/bun-bagel.git`
+2. Install dependencies: `bun install`
+3. Run tests: `bun test`
+4. Build the library: `bun run build`
+
+> [!NOTE]
+>You can also play around with bun-bagel by making changes in the `/sandbox` directory and running `bun run sandbox`. Make sure to build the library after making changes in the `/src` directory.
+
+## 🤝 Community
+
+Join the discussion on the [GitHub Discussions](https://github.com/DRFR0ST/bun-bagel/discussions) page.
+
 ## 📝 License
-This project is licensed under the terms of the MIT license. See the LICENSE file for details.
+This project is licensed under the terms of the MIT license. See the [LICENSE](https://github.com/DRFR0ST/bun-bagel/blob/main/LICENSE) file for details.
 
 #### 📢 Thanks to all contributors for making this library better!
-#### 🤖 Thanks to Gemini for generating most of this code and readme.
+#### 🤖 Thanks to Gemini for generating a part of the initial code and readme, and helped brainstorm the idea.