The more we can both automate fixes of easy-to-catch code issues and ensure that developers can easily access this automation, the less time and energy we have to spend on these issues during the code review process. In addition to saving time, this can reduce the number of comments on a patch, which helps avoid noise and put focus on the important discussions.

Some ideas:

• Add instructions to the development basics section of our code contribution docs for setting up a local environment to take advantage of this automation. This could include:
  • Adding and configuring extensions to VSCode, including Vetur/Volar, ESLint, Stylelint, Code Spell Checker, and Markdown Preview Enhanced. This will help developers catch issues identified by linters, spelling errors, and Markdown syntax issues during development. We could consider a shared vscode config file that would automatically take care of this.
  • Instructions for running linters and autofixing issues
• Consider a pre-commit hook to encourage running tests locally before pushing patches
• Add commit-message-validator

Acceptance criteria

• Consider what else we could automate or better explain in the docs. Collect ideas from the team.
• Make a list of the things we're going to implement here in the acceptance criteria
• Complete those items