Skip to content

Commit

Permalink
Add contributor guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
anjula-sack committed Jan 24, 2024
1 parent 43c0687 commit cf1aa7a
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 6 deletions.
51 changes: 49 additions & 2 deletions docs/gsoc-contributor-guidance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,53 @@
---
sidebar_position: 11
title: GSoC - Guidelines for Students
title: GSoC - Guidelines
---

# GSoC - Guidelines for Students
# Google Summer of Code Contributor Guidelines

Are you interested in participating in a Google Summer of Code project with SEF? We're excited to guide you toward becoming a successful GSoC contributor in our community. To assist you, we've compiled some guidelines and sessions that address your initial questions and provide insight into what is expected of students before proposal submission, after acceptance, and during the coding period.

## Before the Application
1. Familiarize yourself with SEF and the project(s) you're interested in. Refer to the Developer Guide, Getting Started as a Developer, and engage with the community for any queries.
2. Explore project ideas and ask questions in the GSoC category on SEF Hive.
3. Actively participate in SEF slack channel and SEF Hive.
4. Introduce yourself on the introduction thread on SEF Hive.
5. Contribute to SEF by working on github issues. Select issues from github, work on them, and submit pull requests to the respective repository.
6. Identify potential issues in SEF projects. Create new github issues for unreported issues.
7. Increase visibility on SEF Hive and Slack by helping others and engaging in discussions.
8. Conduct code reviews. Reviewing others' code is essential for learning the SEF code base.

**Additional Expectations:**
- Write blogs about SEF or related topics to contribute valuable information to others.
- Properly document your work in Hive and assist others in building on it.

## After Being Accepted
1. Set up a blog for your open source projects, including GSoC. Share the URL on SEF Hive and write weekly posts about planning and project progress during GSoC.
2. Contact your mentor immediately and establish a regular communication plan. Use slack or discussions on SEF Hive for communication.
3. CC your backup mentor in communications to keep them informed of your progress.
4. Review github issues related to your project and work on initial bugs or feature development with guidance from your mentor.
5. Prepare a detailed project plan with SMART goals and milestones, and publish it on SEF Hive.

## During the Coding Period
1. Submit a short weekly progress updates.
2. Write a weekly blog post to share your work publicly.
3. Commit early and often to align with our open-source community values.
4. Prepare mid-term and final project presentation videos for the community.

**Developer Community Expectations:**
- Conduct all project-related discussions on slack or SEF Hive.
- Ask questions in a smart way when facing challenges.
- Participate in the weekly standup calls when your schedule allows.

## After GSoC
1. Write a final blog post summarizing your overall experience. Consider cross-posting to the Google Open Source Blog with approval from org admins.
2. Stay involved with your project or other projects based on your schedule.
3. Monitor SEF Hive for additional questions or feedback about your GSoC project and for other topics of interest.
4. Consider participating as a mentor for GSoC, if SEF is accepted. Your involvement will inspire secondary school students to use their programming skills in open source projects.

## GSoC Awareness Sessions
We have conducted a few GSoC awareness sessions. Check out the links below:

- [Sun's Out with Google Summer of Code 2024](https://www.youtube.com/live/o6rBv_5FfPo?si=CQCPvymFVX51q2DK)
- [Sun's Out with Google Summer of Code 2023](https://www.youtube.com/live/2hFRHc_zNvU?si=uYzptEE-b_MU3tpu)
- [Google Summer of Code Awareness Session](https://youtu.be/cso2YTD3z3s?si=nrmcT8hDKR-iwXTj)
2 changes: 1 addition & 1 deletion docs/handbook/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Handbook",
"position": 8
"position": 11
}
8 changes: 5 additions & 3 deletions docs/project-ideas.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
sidebar_position: 10
---

# Project Ideas
# Google Summer of Code 2024 - Project Ideas

Sustainable Education Foundation is excited to announce our first-time application to be a mentoring organization for [Google Summer of Code](http://g.co/gsoc) 2024! We are eager to be part of this esteemed program and are looking forward to the potential projects and mentorship opportunities available in 2024. Participating in Google Summer of Code with SEF provides a unique chance to enhance your coding skills while contributing to initiatives that have a positive impact on education in developing countries.

If you are new to Sustainable Education Foundation, we recommend going through our [handbook](https://handbook.sefglobal.org/engineering-team/team).


| Project name and outcome | Project rating and length | About the project | Required skills |
|---------------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------|---------------------------|
| Mentor Application Builder | Medium, 175 hours | Create a web-based application for building scholarX mentor applications. | React, TypeScript, Node.js |
| Dashboard to Visualize Program Progress | Medium, 175 hours | Develop a dashboard to visually track the progress of the mentoring program. | React, TypeScript, Node.js |
| ScholarX Integrated Emails for Admins | Medium, 175 hours | Integrate email functionality for admins, allowing them to create and manage email templates and check email statuses. | React, TypeScript, Node.js |
| Individual Profile for Mentors/Mentees | Medium, 175 hours | Develop individual profiles for mentors and mentees to showcase their background, skills, and experiences. | React, TypeScript, Node.js |
| Extension of Academix | Medium, 175 hours | Extend the Academix platform to enable community to contribute to content | React, TypeScript, Node.js |
| ScholarX Messaging | Medium, 175 hours | Create a messaging feature to facilitate communication between mentors and mentees. | React, TypeScript, Node.js |
| Calendar Booking Feature | Medium, 175 hours | Implement a calendar booking feature for scheduling appointments for the mentor within the platform. | React, TypeScript, Node.js |

0 comments on commit cf1aa7a

Please sign in to comment.