Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

High level flow of the contributions process

...

If you are interested in contributing to Sunbird, thank you for taking the first step! This document will help you understand what to do and what to expect in your journey. This is a living document, so please feel free to add any suggestions/comments you have on this discussion thread here.

In this document, we cover what to expect at each of the above stages, and frequently asked questions therein.

...

We have a list of fleshed out product requirements and open bugs that are great candidates for contributions for different levels of expertise at this link. If any of these are of interest to you, you may move to Does a trial.

Suggest a new enhancement

If you wish to add a capability not listed here, you may submit details of your suggested enhancement here. Once submitted, the Sunbird team will respond to you within seven working days.

...

After deciding to take the engagement forward, the Sunbird team will initiate a discussion on the discussion forums introducing you to relevant product and tech leads, who will help you with refining the high level design and capabilities of the enhancement, so it’s in line with the architecture and product principles of the Sunbird suite.

...

Once we have a shared understanding of the high level design, the contributing team will need to request edit access on our open-source project on the Atlassian suite (Jira, Confluence) (here). You should then create Product Requirement Documents (PRDs) and epics and stories in Jira. A primer for how to create documents in Confluence, and epics and stories in Jira can be found in this document. We do this so that future contributors understand the history of how specific features have been built.

...

  • Adding question types in the content player: PRD, Epic

  • Adding new skins to the consumption clients: PRD, Epic

  • Adding a new service to the Knowledge platform: PRD, Epic

Once the PRD and Jira epics/stories are done, the product lead and tech lead will review it to confirm an aligned approach with the Sunbird principles. Once done, the status of the tickets will be changed, and you may begin the development activities.

Outcome at this stage: Clear detailing of the enhancement from a tech design and product lens. Clear breakup of activity into atomic user stories.