Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 2.83 KB

🚀Contributing guide for Open Source Club's Repository

Welcome to our contribution activity! In the upcoming days, you and your team will work on improving our assigned GitHub repository. Maintain a collaborative spirit and focus on high-quality contributions. Your assigned maintainer 🛠️ will guide you through this process and will evaluate your contributions based on quality. 💯

🌟 How You Can Contribute

Your contributions can be in the following areas:

  1. 📖 Improving Documentation: Enhance README files, add comments, or create helpful guides.
  2. 🆕 Adding New Features or Improving Functionality: Implement new features or refine existing ones.
  3. 🐞 Bug Fixing: Identify and fix bugs to improve the codebase.
  4. 💡 Suggesting New Features: Propose meaningful enhancements.
  5. ⚡ Code Optimization: Improve the performance and efficiency of existing features.

📝 Issues and Pull Requests

1. Issues

  • Before working on a feature or bug fix, check if an issue already exists. 🔍
  • If no issue exists, create a new issue describing the problem or enhancement.
  • Maintain clear, concise, and detailed descriptions.

2. Pull Requests (PRs)

  • 🔀 Fork the repository and create a new branch for your changes.
  • 🏷️ Follow proper naming conventions (e.g., feature/add-search-bar or fix/login-bug).
  • 📏 Keep PRs small and focused on a single feature or fix.
  • 📝 Provide a clear title and description for your PR.
  • 🔗 Link to the related issue in your PR description (if applicable).
  • ✅ Ensure your code follows the project's style guidelines.
  • 🧐 Request a review from your maintainer.
  • ❌ Don't raise another issue before completing an existing one. If a contributor raises multiple issues simultaneously, all their issues will be closed by the maintainers.

📚 Resource Section

🔧 Git & GitHub Basics

🌟 Best Practices

  • 🖊️ Write meaningful commit messages.
  • 🏆 Follow coding standards and best practices.
  • 🔄 Regularly pull changes from the main repository to avoid merge conflicts.

🏅 Points System & Evaluation

Your contributions will be evaluated by the maintainer based on:

🏆 Criteria 🎯 Points
📖 Documentation Improvement 0-5
🐞 Bug Fixes 0-10
⚡ Code Optimization 0-10
🆕 New Feature Implementation 0-15

⚠️ Note: Maintainers have full rights to assign or modify points based on the quality & effectiveness of your contributions. ✨

Be sure to communicate with your maintainer 🛠️ and ask for guidance when needed.

Happy coding! 🎉💻🚀