For mentor and mentees

⚠️ This wiki page is for mentor and mentees of CodeDay Labs project only.

Project description

This project aims to provide an end-to-end experience in developing a web app that shares book summary with other people, its idea comes from an open source project idea (https://open-source-ideas.github.io/issue.html?issue=266) and simplified to meet the time constraint.

Technical Details in this google doc: https://docs.google.com/document/d/14ud8gaLRS3Y6R1hksGdwabkhwUIihAzZxesUGyOpmyU/edit#

Schedule

• Jul. 5 - Aug. 6 (4+1 weeks, last week is for presentation)

Working model

Schedule

• 1 online meeting a week for high-level topics, offline discussion anytime in Slack.
• Two 1-on-1 meetings (One during Jul. 12 - Jul. 16, another Jul. 26 - Jul. 30)

Daily collaboration

• During week days at 10am in your local time, send a message in #jerome-wu channel answers 3 questions:
  • What did you do yesterday?
  • What do you plan to do today?
  • Any dependencies or obstacles?
• Commit and push your code to Github at least once a day.
• Create a Pull Request at least once in 3 days.
• Use Github Projects for project management.
• Use Github Issues to raise bugs or discuss potential features.
• Typical flow when developing a feature or fixing a bug
  • Fork the repsitory to your own account
  • Create a new branch with a descriptive name
  • Develop, commit and push your code to the branch you created.
  • Create a Pull Request and assign jeromewu as code reviewers
  • Resolve Pull Request comments (if any)
  • Merge the branch after passing the code review

Must reads

Git

• Convential Commits: to write your commit message in a structural way
• Github Flow: for how we collaborate together

Programming

• Markdown: syntax for writing documents
• Lint: enable lint for the programming language you use, it improves your code quality

Nice to read

• CI/CD: the concept behind bookworms auto deployment

Tips

• If you have bugs that takes you hours and still cannot fix, try to:
  • Explain your problem in Slack #help-desk channel
  • Schedule a pair-programming call with CodeDay staff