Shipping quality code fast is impossible without taking care of the codebase.
To make your code easy to understand, change, and fix fast, Engineers need to keep it maintainable💪
Software maintenance is the process of keeping and updating the software product after it’s been delivered to customers.
The key maintenance goals for engineers are to:
- Document changes that might cause conflicts in the future
- Make pieces of code that cause problems visible
- Refactor those spots in the codebase if needed
What tools can help you with these goals? How do you maintain a healthy codebase? Let’s look at these 5.
1. Comment Anchors: add comments and notes
Adding comments to the code can help you work with any codebase better. Comment Anchors allows you to place anchors within comments or strings to place bookmarks within the context of your code. Anchors can be used to track TODOs, write notes, create foldable sections, or to build a simple navigation making it easier to navigate your files.
Anchors can be viewed for the current file, or throughout the entire workspace, using an easy to use sidebar.
It provides many configuration options, allowing you to tailor this extension to your personal workflow, and increase productivity.
2. Stepsize: add issues to your sprint
If you want to go further than just comments and add key technical issues linked to code to your issue tracker, use Stepsize. Stepsize will help you make technical debt visible and add issues to your sprints directly from your editor.
It allows Engineering teams to:
- Create & view code issues directly in the editor
- Track & prioritise code improvements like technical debt
- Add key issues to Jira, GitHub, Asana, and more
3. DeepScan: detect bugs and quality issues
4. SonarLint: spell checker
5. Glean: refactor code
Once your team found the issues that slow you down you might decide to refactor code. Glean provides refactoring tools for your React codebase: extract JSX into a new component, convert Class Components to Functional Components, wrapping with Hooks. It allows extracting JSX into new component, converting Class Components to Functional Components and vice-verse, wrapping JSX with conditional, renaming state variables and their setters simultaneously, and more.
What are some other tool you use that help you maintain your code? 👇
Top comments (2)
cool article, thanks for sharing. Personally I have also tried P42 which is a pretty cool tool.