Skip to content

Get Started with your Open‐Source Contributions

Abhishek Yadav edited this page Mar 19, 2024 · 9 revisions

Hello Contributors,

Welcome to the C4GT community!

To kick off your contributions to C4GT community projects, follow the steps below and check out the videos for comprehensive guidance on navigating your contribution journey smoothly.

Step 1: Learn about the open-source world & GitHub

Refer to the following links to read about Open Source & become acquainted with GitHub, the tool that makes Open Source possible:

Introduction to Open Source

Introduction to GitHub & Open Source Projects

How to contribute to Open Source

How to use Git

Step 2: Join C4GT discord server & link your GitHub

Watch the video to learn how to complete your Discord onboarding. Click here to join the discord server & don’t forget to link your GitHub account. Linking is of paramount importance because your contributions are tracked and rewards are dispatched only if your GitHub is linked. We follow a DPG Points-based system for incentives. Read more about the DPG Points system & associated rewards here.

You’ll be able to see the “Verified Contributor” badge (check on Roles & Channels > My profile) after completing the three onboarding steps on Discord.

Figure: Onboarding on Discord & linking to GitHub

Step 3: Let’s get started with C4GT issue projects

Once you've honed your basics, learn how to solve projects listed in the C4GT community in the form of issue projects on GitHub by our partner organizations. Please note that the video is only for a tutorial on how the process of PR merger is executed. There's no need to create a beginner ticket. Gain clarity on everything you need to know about how to contribute to the projects by watching the hands-on GitHub workshop below:

How to get started on C4GT issue projects?

Step 4: Explore issue projects on the C4GT website

Go to the C4GT website to explore the list of issue projects posted by various organizations. The page will give you a comprehensive outlook on the nature of the project & tech skills required to accomplish it. Click on a ticket to learn more about it.

Figure: Listed issue projects

Step 5: Let’s deep dive into a ticket

Once you click on the issue ticket hyperlink, you’ll be directed to GitHub. GitHub is the platform for contributing. Understanding the ticket requirements & filling the skill gap in the relevant tech stacks is vital to your contribution journey.

Figure: Issue ticket description

Step 6: Comment on the ticket to show interest and raise a PR or draft PR directly

Once you’re done reading the ticket, you can comment on the ticket tagging Amit or Abhishek from the C4GT team & the respective mentor to show your interest. If you’re confident about the solution, please raise a draft PR directly to showcase your solution. It's always better to coordinate with the mentors on Discord before beginning work on the projects.

Figure: Commenting on a PR

Step 7: Link the PR to the ticket for which the PR has been raised

While raising a PR, please note that the PR should compulsorily be linked to the ticket for which the PR has been raised. That is, the description of the PR should contain a line "Fix for- #<ticket GitHub ID No.>" or "PR for- #<ticket GitHub ID No.>". By linking, GitHub automatically detects that the PR is for that specific community ticket.

Figure: Linking the PR to the primary ticket

Step 8: How to get your doubts cleared?

Now you’re all set to dive deep into the world of C4GT community projects. If you’re facing any issues concerning the projects, don’t worry, C4GT has got you covered. To contribute to these projects, you can take help of the following tools: watch sessions, contact mentors on Discord & join standups.

A. Watch the sessions taken by the organizations to better understand the ticket

Dhiway About Dhiway
How to solve Dhiway’s projects?
FIDE About FIDE
How to solve FIDE’s projects?
ShikshaLokam About ShikshaLokam
How to solve Shikshalokam’s projects?
TIBIL About TIBIL
How to solve TIBIL’s projects?
Project Tech for Dev About Project Tech for Dev & its projects
Samagra X About Samagra X & Overview of projects
Unified Communications Interface
Nipun Lakshya App

B. Reach out to the mentors on Discord

There are dedicated Discord channels for every organization. You can enable these channels on Channels & Roles > Browse Channels > Organizations. Do tag the mentors while asking your queries/ doubts on the channel. You can also ask your queries on the discussion channel to seek input from the larger community.

Figure: Enabling Org channels

C. Join the weekly connects conducted by organizations with mentors

We organize weekly & fortnightly catch-ups with some mentors who are mentoring the issue projects. Do join these calls to interact with the mentors & clarify your doubts. We’ll keep you notified about the weekly connects on our discord server Events section.

Figure: Marking weekly standups on Discord

Step 9: Get your PRs merged to earn points and feature on the leaderboard.

You can check your DPG points on the leaderboard. You can use the Certificates & Badges channel to download your level-wise verifiable Certificates & snapshots to be embedded in your GitHub profile.

FAQs

1. Why am I not able to see the “Verified Contributor” badge on my profile? What should I do to resolve this issue?

Please make sure that you’ve completed the three onboarding steps on Discord. Watch the video to learn more about the process. The steps are:

a) Introducing yourself in the correct proforma as mentioned in the channel description

b) Linking your functional GitHub ID to Discord. It should show a message displaying that authentication is successful.

c) Read the Code of Conduct

You’ll be able to see the “Verified Contributor” badge (check on Roles & Channels > My profile) after completing the above three steps. In case you’re not able to see it, wait for ~24 hours, if the issue still persists, do reach out on the community support channel.

2. Why are my DPG points not getting reflected on the leaderboard?

Check the following before raising it on the community support.

  1. Make sure the ticket for which you’re raising a PR has a community label
  2. While raising a PR, please note that the PR should compulsorily be linked to the ticket for which the PR has been raised. That is, the description of the PR should contain a line "Fix for- #< ticket GitHub ID No.>" or "PR for- #< ticket GitHub ID No.>". By linking, GitHub automatically detects that the PR is for that specific community ticket.
  3. Please ensure the GitHub ticket is showing “Merged”
  4. If all these steps are complete, and the issue still persists, flag it on the community support channel

3) How to download the certificates & GitHub snapshots for my contributions?

We follow a DPG Points-based system for incentives. Read more about the DPG Points system & associated rewards here. You are eligible to get certificates & badges as per your contribution levels i.e. Bronze, Silver, etc. Please note, that points are only awarded for successfully merged PRs.

To download the certificates & badges, watch the video.

Dedicated Mentoring Program

C4GT Community Campaigns

Open Community Projects

Augtoberfest

Standards and Frameworks

Clone this wiki locally