Refine workspace/linting docs (scope .vscode statement, drop overclaim) - #406
Merged
Conversation
…claim - AGENTS.md: stop claiming "every structured file type" is linted; list the extensions' actual coverage (C#, Markdown, Dockerfiles/Compose, GitHub Actions, spelling). Scope the workspace convention to settings/extension recommendations/spell-check words and note that build/debug tasks still live in .vscode/tasks.json and .vscode/launch.json. - copilot-instructions.md: scope "belongs in the workspace, not .vscode/" to editor settings/recommendations/spell-check words, so it no longer contradicts the tracked .vscode/tasks.json. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR refines repository documentation around VS Code workspace usage and in-editor linting to avoid over-claiming coverage and to accurately scope what belongs in NxWitness.code-workspace versus .vscode/.
Changes:
- Update AGENTS.md to (a) scope the “workspace, not .vscode” convention to settings/recommendations/spell-check words while explicitly acknowledging
.vscode/tasks.json/.vscode/launch.json, and (b) replace the “every structured file type” linting claim with a concrete list of covered file types/tools. - Update .github/copilot-instructions.md to align the “belongs in the workspace” statement with the scoped definition (editor settings/recommendations/spell-check words), removing the implied contradiction with tracked
.vscode/*files.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
AGENTS.md |
Clarifies workspace vs .vscode/ responsibilities and narrows linting claims to the actually recommended extension coverage. |
.github/copilot-instructions.md |
Aligns Copilot guidance with the scoped workspace convention described in AGENTS.md. |
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
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.
Follow-up to #402, addressing two Copilot doc comments on #403:
.vscode/extensions.json/redhat.vscode-yamlis gone); it lists the extensions' actual coverage. The workspace convention is scoped to settings/extension recommendations/spell-check words, and notes that build/debug tasks still live in.vscode/tasks.json/launch.json..vscode/" statement the same way, so it no longer contradicts the tracked.vscode/tasks.jsonreferenced elsewhere in the doc.Docs-only.
🤖 Generated with Claude Code