Skip to content

Latest commit

ย 

History

History
63 lines (50 loc) ยท 3.06 KB

File metadata and controls

63 lines (50 loc) ยท 3.06 KB

โœจ Student Guide โœจ

git

๐Ÿš€ Why Should You Apply?

While youโ€™ll be adding your piece of code to the existing codebase, you will get to learn the structure of the project and more about the process of creating it from scratch. That, in future will help you in creating your own projects. If You donโ€™t know how to code it's fine contributing is not all about coding you can still contribute in documentation of project or improving existing documentation by fixing typos or broken links etc .

๐Ÿš€ requirements

  • A Working Laptop / PC With Internet Connection
  • A github account if you dont have sign up now

๐Ÿš€ Leaderboard

The leaderboard which displays all the activities by registered students would be live at the website. Basically it represents the activity of each and every student registered.

๐Ÿš€ Choosing A Project

First of all, you can choose as many projects as you want. Itโ€™s not about doing everything on just one project, but solving as many issues as you can, contributing as much as you can.

๐Ÿš€ Adding Your Own Project

Summer of Code is about working on Open Source . In case you did not like any of the projects listed. Tell us about the project youโ€™re working on, add your project as mentor.

๐Ÿš€ steps

  • fork your mentor's project -> clone repository -> code -> push -> send pull request

๐Ÿš€ steps for clone and push

git

๐Ÿš€ Coding Style

Almost all the languages have a definitive style guide for them. Putting correct indentation, obeying line lengths, etc. are the features which make the code more and more readable.You should work with your mentor about the code styling.

๐Ÿš€ Writing Documentation

The code that you have added must be documented thoroughly. Open Source is about writing code that humans can read and understand. Without documentation, it is so hard to read any code. Hence, add information in README, in the comments of code etc. Ask the mentor to help you out with it.

๐Ÿš€ resources

  • The Simplest Guide git-guide
  • Overview of first contribution. follow given steps for your first contribution
  • A Medium Article
  • A Youtube video. Donโ€™t be afraid if you donโ€™t have a Linux / Mac you can use git commands in windows using git bash

๐Ÿš€ Contact

The contact details of each mentor will be available to you on the projects list. So, you have every right to contact the mentor and ask for help on the project.At the same time, we do hope that the participants be polite while making contact. One should realise that after all, the mentors are students themselves, and they might not always be available at the momentโ€™s notice. Ideally one should wait for at least a day for the mentorโ€™s reply.