Repository navigation
Docs/documentation standard compliance #204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
MGibson1
wants to merge
4
commits into
main
Choose a base branch
from
docs/documentation-standard-compliance
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
34a9334
Replace README with the repo skeleton from the documentation standard
MGibson1 dcae337
Extract bitwarden-init claude.md stubs verbatim
MGibson1 aaf7fda
Merge branch 'main' into docs/documentation-standard-compliance
withinfocus de42d93
Remove deprecated recommendation
MGibson1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,55 @@ | ||
| # Claude Code Configuration | ||
| # Repository name - Claude Code Configuration | ||
|
|
||
| TODO: see https://bitwarden.atlassian.net/wiki/x/LgDMaQ for configuration tips to complete the `.claude/CLAUDE.md` file | ||
| <!-- | ||
| Template guidance — delete this comment when customizing your new repo. | ||
|
|
||
| Run /bitwarden-init:init to generate this file from an analysis of your | ||
|
withinfocus marked this conversation as resolved.
|
||
| codebase. It fills the sections below and requires these exact headings: | ||
| https://github.com/bitwarden/ai-plugins/tree/main/plugins/bitwarden-init | ||
| --> | ||
|
|
||
| Brief description of the project and its primary purpose. | ||
|
|
||
| ## Overview | ||
|
|
||
| What this project does, key concepts, and target consumers. | ||
|
|
||
| ## Architecture & Patterns | ||
|
|
||
| System architecture, code organization, key principles, and core patterns. | ||
|
|
||
| ## Development Guide | ||
|
|
||
| Step-by-step instructions for the most common development tasks. | ||
|
|
||
| ## Data Models | ||
|
|
||
| Core types and validation schemas. | ||
|
|
||
| ## Security & Configuration | ||
|
|
||
| Security rules, environment configuration, and authentication. | ||
|
|
||
| ## Testing | ||
|
|
||
| Test structure, writing tests, and running tests. | ||
|
|
||
| ## Code Style & Standards | ||
|
|
||
| Formatting, naming conventions, and pre-commit hooks. | ||
|
|
||
| ## Anti-Patterns | ||
|
|
||
| DO and DON'T lists. | ||
|
|
||
| ## Deployment | ||
|
|
||
| Building, versioning, and publishing. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| Common issues and debug tips. | ||
|
|
||
| ## References | ||
|
|
||
| Official documentation, internal documentation, and tools. | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💭 Some of these sections don't look like they'd meet the "information Claude always needs in every session" bar. We intentionally ask that
CLAUDE.mdbe lean so that we don't introduce unnecessary context into every session. They're asking for details that are better suited as Skills or Rules.Where documentation lives contradicts what the template is requiring, primarily because it "gives a second home" to much of what it's asking for. Some explicitly called out in the contributing docs.
A quick scan of
bitwarden-initdoes not route anything to Rules or Skills, so everything gets dumped here. It doesn't appear to look for or respect README or any otherdocs/that may exist and no instructions to not duplicate them inCLAUDE.md. I've not personally runbitwarden-initon any repos, and none of our existing ones appear to have used it either. If it's not updated to align with our documentation standards, I'm hesitant to suggest using this. It's just going to create tech-debt that someone has to cleanup.In a new repo, would
bitwarden-initeven produce anything of value until a meaningful amount of source code is present. Someone using this template has no guidance on when to runbitwarden-initto get value from it.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was able to find a few repos that used the template, and they mostly validate my concerns. Repeating documentation that has drifted, instructions that are clearly task-specific, and rules that only apply to specific files/paths. Several are pretty long too, ranging from 700 to 1500 lines, and were never reviewed by the AI team.