Understanding how a new codebase works is difficult. Traditionally, developers have used either inline comments or external documentation to explain how things work.
These methods can work fairly well for developers that already have some familiarity with the code; however, they are not ideal for onboarding (or reboarding) new engineers to the team.
The current tools we have for onboarding developers aren't great.
CodeTour is a VS Code extension that allows development teams to visually explain a codebase.
With CodeTour, developers can add the much-needed context in their codebase through a collection of tour “steps” with the following attributes:
With Coder, development teams can source-control their development environments and run them in their cloud. We can configure a Coder image to automatically install the CodeTour extension and save an extra step in the onboarding process. Coder images can also contain any other extensions, software, or dependencies that a project needs.
To add the CodeTour extension to Coder images, you’ll need to include a configure script that runs on startup. To do this, add the following line to your Dockerfile:
COPY [ "configure", "/coder/configure" ]
Then, create the
configure file in the same directory and edit it
$ touch configure $ chmod +x configure $ vi configure
configure file, we want to tell code-server to install a new extension. In this case, CodeTour.
# Configure script that runs on environment startup # Install CodeTour extension on code-server /tmp/coder/code-server/bin/code-server --install-extension vsls-contrib.codetour
What are your thoughts on this post? Let me know on Twitter.