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 setup 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.

Engineering

• Setting up the codebase: Follow this beautifully written development setup guide.

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.

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

Dependabot

Dependabot will send us pull requests everytime there are 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!

Occassionally, some dependabot updates have breaking changes. Follow this doc to learn how to fix.

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.
• Before building a component, please check the storybook (LINK PLEase) to reuse existing components!