Onboarding

Getting Started

• You first step at any new company you join as an engineer is to improve documentation. Starting from here, try to read through the relevant documentation and set up your codebase. When you get stuck, ask for help and then edit and improve the document you are reading to make it easier for the next engineer that joins.

  • PRO TIP - You should always be improving documentation, no matter who wrote the original document, no matter how new you are, no matter how pro you've become.

• Made a contribution? Let all contributors bot know

Engineering

• Read A Request Journey to get an understand of what happens behind the scenes when you used c0d3.com. It should help you get overview of the codebase.
• Setting up the codebase: Follow this beautifully written development setup guide.

Responsibilities

• Review Pull Requests - Always help your teammates out by reviewing pull requests
  • Keep our codebase updated and protected by updating libraries via dependabot
• Attend weekly sprint meetings - If a time is inconvenient for you, feel free to propose alternatives!
• Please continue reviewing submissions, especially JS5 and JS6! All js6 submissions can only be reviewed by the engineering team.
• Before starting a big feature or a big change, please write a design doc to document why the change is needed and how you plan to execute the change. Also it would be helpful to link to any documentation for the research you have done. Create an issue and label it design doc. List of previous design docs created thus far
  • Read about Design Docs at Google
  • Common headers you may want to consider when writing your design docs: Problem, Architecture Changes, Subtasks, Research.

Reviewing Pull Requests

Like reading and updating documentation, reviewing pull requests is something you should do from the beginning of your engineering career to the end of your engineering career. When you first join a team, reviewing your teammate's existing pull requests could help you quickly familiarize yourself with what your teammates are working on and gives you a good opportunity to ask questions. Please ask questions when you have questions about the pull request!

c0d3 team requires 2 engineering approvals and passing CI/CD builds before a pull request can be merged in.

Dependabot will send us pull requests every time there are package updates to make sure all of our libraries are up-to-date. Make sure to stay on top of dependabot pull requests and help us merge in package updates by following this doc

Note:

• Please make sure to test if the live preview of the pull request is working correctly before approving/merging

Best Practices

Testing

A list of tips for you!

Front-End

• When writing tests, please write out the actual changes instead of toMatchSnapShot(). If we get lazy and use toMatchSnapShots all over the place, our tests slow down significantly and when we update a common component like the AppNav, there would be hundreds of snapshots to update.
  • Example of what you should not to do. In that example, it is taking snapshots repeatedly to make sure search filters are working. Instead, it is better to select the results and expect the number of results to be X.
• Before building a component, please check the storybook to reuse existing components!
• CSS classnames - follow BEM Syntax. In a nutshell, .block--modifier__element
  • Examples: .person--female__hand and .person__hand--left
• Accessibility
  • Use proper headings