docs: update template repo linting docs for git-hook and CI linting#827
Merged
Conversation
The Local linting section described Husky + lint-staged installed via npm, which no longer exists in the template repo. Rewrite it to match bitwarden/template#201: a pre-commit git hook and matching CI lint workflow running Prettier and CSpell over Markdown and config files, with repos expected to add linters for their own languages. Rename the heading to Linting since it now covers CI as well.
Contributor
🤖 Bitwarden Claude Code ReviewOverall Assessment: APPROVE This is a documentation-only change to Code Review DetailsNo findings. |
Deploying contributing-docs with
|
| Latest commit: |
87cc130
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b1553a7d.contributing-docs.pages.dev |
| Branch Preview URL: | https://docs-template-repo-linting.contributing-docs.pages.dev |
theMickster
approved these changes
Jul 1, 2026
MGibson1
approved these changes
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎟️ Tracking
Documents bitwarden/template#201, which replaced the template repository's local linting setup with a git-hook and CI approach.
📔 Objective
Rewrites the linting section of the Template Repository page to match bitwarden/template#201. The old "Local linting" section described Husky and lint-staged installed via
npm install, which no longer exists in the template (there is no longer apackage.json). The section now describes the current setup: apre-commitgit hook and a matching CI workflow that run Prettier and CSpell over Markdown and config files, and notes that repositories are expected to add and configure linters for their own languages. The heading is renamed from "Local linting" to "Linting" since it now covers CI as well.