This guide provides essential information for contributors to our open-source projects. Whether you're a seasoned developer or just starting out, your input is valuable! 🛠️
📚 Contribution Overview
- Code Quality: Always follow our Code of Conduct to ensure consistency.
- Documentation: Help improve our Developer Guidelines for better clarity.
- Reporting Issues: Use our Issue Tracker to share feedback or bugs.
🚀 How to Get Started
- Fork the Repository 📁
Start by forking the main project repo on GitHub. - Clone Your Fork 🔄
git clone https://github.com/your_username/project.git
- Set Up the Environment 🛠️
Follow the setup instructions in the Getting Started guide.
📝 Code Contribution Standards
- Naming Conventions: Use PascalCase for classes and snake_case for variables.
- Commit Messages: Keep them concise and descriptive (e.g.,
Fix: typo in README
). - Pull Requests: Ensure your PR includes tests and updates documentation.
📌 Submission Process
- Make changes to your local copy.
- Commit and push to your fork.
- Open a pull request to the main branch.
- Wait for feedback and iterate if needed.
🧩 Common Questions
- Q: How do I format my code?
A: Refer to the Code Style Guide. - Q: What if my PR is rejected?
A: Don’t worry! Review Process is a learning opportunity.
Let’s build something amazing together! 🌈