Code analysis
Check if code is readable by non-developers - clear names, plain English comments, no jargonFrom its SKILL.md
npx -y skills add bg-szy/TOP-SKILLS --skill code-analysisAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 4 stars4 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.3 KB, 261 tokens by cl100k_base, as published. Nobody here has run it
Code Readability Checker
Analyzes code to ensure non-developers (managers, stakeholders, new team members) can understand it.
What It Checks
- Clear naming: No cryptic abbreviations (usr_tkn → userToken)
- Plain comments: Everyday language, not technical jargon
- Documentation: What/Why/How for major sections
- Comment ratio: At least 20% of lines should be comments
Usage
python3 analyze.py --path your-file.py --strictness lenient
Example
Bad Code (score: 71/100):
def proc(usr, tkn):
tmp = usr + tkn
return tmp * 2
Issues: Cryptic names, no comments, unclear purpose.
Good Code (score: 95/100):
def process_user_authentication(username, auth_token):
"""Validate user credentials and return auth score"""
combined_credential = username + auth_token
return combined_credential * 2
Known Issues
- May flag false positives in documentation files
- Works best on actual production code
- Use
--strictness lenientto reduce noise
What ships with it: 2 files
44.7 KB alongside SKILL.md, 1 of them executable
- analyze.pyruns31.2 KB
- skill-report.json13.5 KB