Skip to content

SLoP 2020

Jump to bottom
Praneeth edited this page Mar 17, 2023 · 1 revision

Note: For details about the programme have a look at Oppia-SLoP.

Instructions for students

How do I get started?

  1. Register as a student on the SLoP website.
  2. Follow the instructions on the Getting Started page. Please note, when filling up the contributor survey please indicate that you are taking part in SLoP.
  3. Once you have submitted the CLA and New Contributor Survey, you will be contacted by your on-boarding mentor (mostly within 24 hours) who will help you make your first contributions to Oppia-Android. But while you wait for the mentor to contact you, feel free to take a look at following resources:
  4. Your onboarding mentor will suggest starter issues for you to work on. These issues will have score labels of the form “SLoP-<number>”.
  5. If you would like to take up issues that are not part of above labels or do not have a score label, please contact your onboarding mentor and request for the score for the issue. Your mentor will assign a score to the issue and communicate the same to the org admins. The org admins will then add the relevant label to the issue.

Expectations from students

  1. Look for issues which are not assigned to anyone and comment on the issue mentioning your mentor name that you would like to work on it. Once the mentor approves you can start working on it.
  2. Make sure that the issue that you are working on has a score assigned to it before you finish the PR for that issue.
  3. Keep in touch with your mentor and give updates on regular time intervals. This can be something which you can figure out with your mentor. It's a good practice to communicate to your mentor atleast once a week.
  4. Your PRs should get reviewed by your mentor within 24 hours but if for some reason the mentor is not reachable for more than 24 hours then assign your PRs to Rajat (@rt4914) for review. NOTE: wait for atleast 24 hours to get a reply from a mentor.
  5. In case of any doubts or issues you should immediately talk to your mentor.

Instructions for mentors

Who are the mentors?

For initial 2 PRs default mentors will be Ben and Rajat. After 2 PRs tentative mentor list: Akshay, Mohamed, Pulkit, Sarthak

Expectations

  1. Please review assigned PRs within a 24 hr period.
    • If you cannot review in that time frame, due to a one-off problem, please communicate the same in the PR thread and mention when you
    • would be able to review the PR. If you cannot review PRs in a 24 hr time frame for an extended period, consider temporarily assigning code-ownership to another experienced contributor.
  2. If a student shows no activity for an assigned issue for >1 week, de-assign them so that other contributors get a chance to work on the issue.
  3. Project leads may need to score project specific issues if a student requests to work on them (see “Scoring”).
  4. Mentors are encouraged to have check-ins with their students on a weekly basis to make sure the students aren't stuck and are having a positive experience.
  5. The level of mentoring is expected to be slightly higher than that of hacktoberfest and dealing with new contributors but less than that of GSoC. Please note: Apart from the standard “24 hr review” rule, there is no formal time commitment for a mentor.

Scoring Policy

The set of points allowed to be allocated to each issue are:

  • 5 Points - Level 1
  • 25 Points - Level 2
  • 75 Points - Level 3
  • 150 Points - Level 4

5 Points

  • Very Easy Issue - Beginner level
  • GitHub Issue Label: SLoP-5
  • Example: 1 line change in code, Typo fix in Documentation

25 Points

  • Easy-Moderate issue
  • GitHub Issue Label: SLoP-25
  • Example: A small bug fix, minor refactor or contributions spanning to few lines of code

75 Points

  • Moderately Difficult issue
  • GitHub Issue Label: SLoP-75
  • Example: Addition of small feature, contribution that has fair bit of learning involved

150 Points

  • Difficult Issue
  • GitHub Issue Label: SLoP-150
  • Example: Major bug fix, a contribution that requires heavy effort and research, Good new feature implemented

NOTE: At any point before PR gets merged mentors can increase or decrease points.

Escalation Policy

If there are any SLoP-related doubts / concerns, please reach out to the org admins (@kevintab95, @rt4914, @BenHenning).

Have an idea for how to improve the wiki? Please help make our documentation better by following our instructions for contributing to the wiki.

Core documentation

Developing Oppia

Developer Reference

Clone this wiki locally