Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 2.52 KB

ONBOARDING.md

File metadata and controls

36 lines (30 loc) · 2.52 KB
Raw

Cherry Onboarding Guide

Github

Cherry is a monorepo that lives on Github. This means that both frontend and backend codebases are located in the same repo (in the backend and web directories) https://github.com/open-source-at-illinois/cherry.
Send your github username and tag an exec member on discord to be added as a contributor!

Discord

Discord is where all communication takes place. Cherry has some special channels that you can access by clicking on the reaction in this announcement (or @mention an exec member!). If you haven’t already, Join our discord server here.

Calendar

Club meetings will show up on the OSAI Calendar, which you can subscribe to using this link.

Jira

Jira is our project management tool, where different tasks and issues will be assigned to developers. To get access to the Jira project, DM your Illinois email to an exec member!

Meetings

Cherry has 2 kinds of meetings:

  • Project Planning Meetings which take place during the weekly club meetings (Wednesday 5PM at Siebel 1302)
    • In these meetings, the team makes decisions on the project. (How something should look/behave etc.)
  • Standup Meetings which are short 10 minute meetings that take place at 9 PM every Tuesday, Thursday, and Sunday.
    • In standups, everyone in the team describes 3 things:
      1. Any progress/roadblocks since the last meeting
      2. What they are working on currently
      3. What is planned to be done before the next meeting
    • These meetings ensure that everyone on the team is on the same page, and any issues are quickly addressed

Contributing

Some guidelines to follow when writing code:

  • Write readable, clean code that is easy to understand. Follow good practices like writing descriptive commit messages, variable names and documentation. Write code you can be proud of!
  • Use branches!
    • When working on a feature, make a new branch for that feature using the command git checkout -b <branch name> (or switch to an existing branch without the -b)
    • Commit frequently!
    • Make a pull request to the develop branch when done, and add your scrum master as a reviewer for the PR. Also a good idea to @ them on discord so they don’t miss it!
  • Make mistakes! At OSAI, we highly encourage failure.
    • When in doubt, ask! Your team’s scrum master and product owner are great resources when in doubt about the project – don’t hesitate to reach out!