|
| 1 | +# Contributing to StashBlob |
| 2 | + |
| 3 | +**Welcome!** We're excited that you want to contribute to our project, StashBlob. Here are some simple guidelines to help you get started. |
| 4 | + |
| 5 | +## 1. What is StashBlob?** |
| 6 | + |
| 7 | +StashBlob is a tool that lets you upload, optimize, and easily share your files. |
| 8 | + |
| 9 | +## 2. Getting Started |
| 10 | + |
| 11 | +- To contribute, you'll need some basic knowledge of programming and the tools we use. |
| 12 | +- Our project is currently in the `v0 beta` version, so you might encounter some bugs. Your help in fixing them is greatly appreciated. |
| 13 | + |
| 14 | +## 3. How to Contribute |
| 15 | + |
| 16 | +- **Bug Reports:** If you find a bug, let us know. Describe what happened and how to reproduce it. |
| 17 | +- **Feature Requests:** Have an idea to improve StashBlob? Tell us about it. |
| 18 | +- **Code Contributions:** If you're a developer, you can submit code changes. Make sure they align with the project's goals. |
| 19 | +- **Documentation:** Help us improve our documentation so others to understand the project better. |
| 20 | + |
| 21 | +## 4. Code Contributions |
| 22 | + |
| 23 | +- Before you start coding, discuss your idea with us. We'll guide you in the right direction. |
| 24 | +- Use clear and simple code that follows our coding standards. |
| 25 | +- Comment your code so others can understand it. |
| 26 | +- Test your changes thoroughly before submitting. |
| 27 | + |
| 28 | +## 5. Pull Requests |
| 29 | + |
| 30 | +- When you're ready to submit your changes, create a Pull Request (PR) on our repository. |
| 31 | +- Describe what your PR does and how to test it. |
| 32 | +- Be open to feedback and willing to make changes if needed. |
| 33 | + |
| 34 | +## 6. Communication |
| 35 | + |
| 36 | +- We use GitHub for most of our communication. Feel free to ask questions and join discussions. |
| 37 | + |
| 38 | +## 7. Be Respectful |
| 39 | + |
| 40 | +- Treat others with respect, and follow our Code of Conduct. We're here to help each other. |
| 41 | + |
| 42 | +## 8. Credits |
| 43 | + |
| 44 | +- We'll give you credit for your contributions. Your name will be on our contributors' list. |
| 45 | + |
| 46 | +That's it! Thank you for considering contributing to StashBlob. Your help is invaluable in making our project better. If you have any questions, just ask. Happy coding! |
| 47 | + |
| 48 | +<div>Best regards,</div> |
| 49 | +<div>Timi</div> |
| 50 | +<div>Founder, StashBlob Project</div> |
0 commit comments