Add lean-comments skill 🤖🤖🤖 - #3137
Open
JonathanXDR wants to merge 1 commit into
Open
JonathanXDR wants to merge 1 commit into
JonathanXDR wants to merge 1 commit into
Conversation
Contributor
🔒 PR Risk Scan ResultsScanned 1 changed file(s).
✅ No matching risk patterns were detected in changed files.
|
Contributor
|
🔴 Contributor Reputation Check: HIGH risk
Maintainers: please review this contributor before merging. |
17 tasks
Contributor
🔍 Vally Lint Results✅ All checks passed
Summary
Full linter output |
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.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.mainbranch for this pull request.Description
Adds
lean-comments, a skill that decides whether a source-code comment should exist before deciding how it should read.The default is no comment. A comment survives only when it preserves meaningful, non-obvious information a competent maintainer could not recover from the code, names, types, signatures, tests, configuration, or nearby repository context. Everything else gets removed rather than reworded.
It covers line comments, doc comments, docstrings, file headers, and stale
TODO/FIXME/HACKmarkers, and it protects lint, compiler, and license directives. It refuses to invent a security, performance, or compatibility rationale to justify keeping a comment, which is the common failure mode when an agent is asked to "improve the comments".Source repository: https://github.com/JonathanXDR/lean-comments (MIT).
Type of Contribution
Additional Notes
On the one unchecked box: this skill has been used in day-to-day agent work and validated against this repository's own gates (
npm run skill:validatepasses for all 419 skills, andnpx @microsoft/vally-cli lint skills/lean-commentsreports 2/2 checks passed), but I have not run it specifically inside GitHub Copilot, so I have left that box unticked rather than tick it on assumption.On overlap: the two existing comment-related skills,
add-educational-commentsandcomment-code-generate-a-tutorial, both add explanatory commentary for teaching. This one is the inverse. It removes commentary that carries no information, so it does not duplicate either.docs/README.skills.mdwas regenerated withnpm startand contains exactly the one new row.