Skip to content

Latest commit

 

History

History
109 lines (82 loc) · 4.64 KB

contributor-guidance.md

File metadata and controls

109 lines (82 loc) · 4.64 KB

Contributor Guidance for GSoC at DevRhylme Foundation

Welcome to the Google Summer of Code (GSoC) program at DevRhylme Foundation! This document serves as a guide for contributors looking to participate in our projects. Follow the instructions carefully to ensure a smooth onboarding and productive engagement.

📌 About DevRhylme Foundation

DevRhylme Foundation is dedicated to fostering innovation through open-source contributions. We work on cutting-edge technologies, including web development, blockchain, AI, and DevOps, and provide a collaborative environment for learning and building impactful solutions.

🚀 Getting Started

Step 1: Understand GSoC and Our Projects

  • Read about Google Summer of Code here.
  • Browse through our list of GSoC project ideas on our GitHub.
  • Choose a project that aligns with your skills and interests.

Step 2: Join the Community

  • Join our Slack/Discord community to interact with mentors and contributors.
  • Subscribe to our Mailing List for updates.
  • Attend our Introductory Sessions.

Step 3: Set Up Your Development Environment

  • Fork and clone the repository of the project you’re interested in.
  • Read the README.md and follow setup instructions.
  • Install dependencies and ensure the project runs locally.

Step 4: Make Your First Contribution

  • Browse through the Issues tab on GitHub.
  • Start with Good First Issues.
  • Follow the contribution guidelines and submit a Pull Request (PR).

Step 5: Prepare Your GSoC Proposal

  • Draft a proposal with the following structure:
    • Title
    • Synopsis
    • Benefits to the Community
    • Deliverables & Timeline
    • Technical Details
    • Expected Outcomes
    • Personal Information & Contact Details
  • Get feedback from mentors before final submission.

✅ Contributor Guidelines

Code of Conduct

  • Be respectful and inclusive.
  • Follow ethical coding practices.
  • Avoid spammy or low-quality contributions.

Coding Standards

  • Follow project-specific coding standards (check the CONTRIBUTING.md file).
  • Write clean, well-documented, and tested code.

Commit & PR Guidelines

  • Write clear commit messages (e.g., feat: Added API endpoint for user authentication).
  • Follow the branching strategy (feature/your-feature-name).
  • Ensure your PR includes relevant issue references (Fixes #IssueNumber).

Communication

  • Use public communication channels for discussions.
  • Be responsive and respectful in your interactions.

🔍 General Instructions

📌 Recommended Steps

  1. Read the GSoC Student Manual, especially writing a proposal.
  2. Read the DevRhylme Foundation Handbook to understand our goals and contribution process.
  3. Check out the list of project ideas.
  4. Choose a project and write a draft proposal.
  5. Get feedback from mentors on your draft.
  6. Submit your proposal ahead of the deadline.
  7. Submit proof of enrollment early.

💡 Hints for a Strong Application

  • Submit early: Early submissions get more mentor attention.
  • Avoid last-minute rush: Servers may be overloaded.
  • Keep it clear and concise: Provide a descriptive title.
  • Be realistic: Choose a feasible project scope.
  • Explore multiple areas: You can submit multiple proposals but prioritize quality over quantity.

🎯 Expectations from Accepted Contributors

  • Complete your project under mentor guidance.
  • Submit code regularly and stay in frequent communication.
  • Pass evaluations by meeting both coding and communication expectations.

📚 Resources

🤝 Need Help?

If you have any questions, feel free to reach out to your mentors or ask in the community channels. We’re excited to have you onboard and look forward to your contributions!

Happy coding! 🚀

Content based on https://community.kde.org/GSoC and available under Creative Commons License SA 4.0.