agentleFS
ertugrul-dmrertugrul-dmr/clean-code-skills/skills/typescript/boy-scout/SKILL.md

boy-scout

Skill193 starsChanged 7 months agoMITView on GitHub

Use when fixing, editing, changing, debugging, or working with any TypeScript code. Applies the Boy Scout Rule—always leave code cleaner than you found it. Orchestrates other clean code skills as needed.

3 other projects use a version of this, 2 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

12 rules. About 0 are common, 10 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈10

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If we all followed this simple rule:

    line 20
  2. Distinctive:

    Every time you touch code, look for at least one small improvement:

    line 27
  3. Very specific:

    Delete a redundant comment -> triggers clean-comments

    line 31
  4. Distinctive:

    Remove dead code or unused imports

    line 32
  5. Very specific:

    Remove duplication (DRY) -> triggers clean-general

    line 38
  6. Distinctive:

    Add missing boundary checks

    line 39
  7. Distinctive:

    Leave code worse than you found it

    line 98
  8. Distinctive:

    Wait for a dedicated refactoring sprint

    line 100
  9. Distinctive:

    Keep changes proportional to your task

    line 106
  10. Distinctive:

    Leave a trail of quality improvements

    line 107
  11. Distinctive:

    When working on code:

    line 111
  12. Distinctive:

    Every piece of code you touch gets a little better.

    line 124

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

The Boy Scout Rule

"Always leave the campground cleaner than you found it." — Robert Baden-Powell

"Always check a module in cleaner than when you checked it out." — Robert C. Martin, Clean Code

The Philosophy

You don't have to make every module perfect. You simply have to make it a little bit better than when you found it.

If we all followed this simple rule:

  • Our systems would gradually get better as they evolved
  • Teams would care for the system as a whole
  • The relentless deterioration of software would end

When Working on Code

Every time you touch code, look for at least one small improvement:

Quick Wins (Do These Immediately)

  • Rename a poorly named variable -> triggers clean-names
  • Delete a redundant comment -> triggers clean-comments
  • Remove dead code or unused imports
  • Replace a magic number with a named constant
  • Extract a deeply nested block into a well-named function

Deeper Improvements (When Time Allows)

  • Split a function that does multiple things -> triggers clean-functions
  • Remove duplication (DRY) -> triggers clean-general
  • Add missing boundary checks
  • Improve test coverage -> triggers clean-tests

The Rule in Practice

// You're asked to fix a bug in this function:
function proc(d: number[], x: number[], flag = false): number[] {
  // process data
  for (const i of d) {
    if (i > 0) {
      if (flag) {
        x.push(i * 1.0825); // tax
      } else {
        x.push(i);
      }
    }
  }
  return x;
}

// Don't just fix the bug and leave.
// Leave it cleaner:
const TAX_RATE = 0.0825;

/** Filter positive values, optionally applying tax. */
function processPositiveValues(
  values: readonly number[],
  applyTax = false
): number[] {
  const rate = applyTax ? 1 + TAX_RATE : 1;
  return values.filter((v) => v > 0).map((v) => v * rate);
}

What changed:

  • ✅ Descriptive function name
  • ✅ Clear parameter names
  • ✅ Explicit TypeScript types
  • ✅ Named constant for magic number
  • ✅ No output argument mutation
  • ✅ Useful inline documentation

Skill Orchestration

This skill coordinates with specialized skills based on what you're doing:

TaskTrigger Skill
Writing/reviewing any TypeScripttypescript-clean-code (master)
Naming variables, functions, classesclean-names
Writing or editing commentsclean-comments
Creating or refactoring functionsclean-functions
Reviewing code qualityclean-general
Writing or reviewing testsclean-tests

The Mindset

Don't:

  • Leave code worse than you found it
  • Say "that's not my code"
  • Wait for a dedicated refactoring sprint
  • Make massive changes unrelated to your task

Do:

  • Make one small improvement with every commit
  • Fix what you see, even if you didn't break it
  • Keep changes proportional to your task
  • Leave a trail of quality improvements

AI Behavior

When working on code:

  1. Complete the requested task first
  2. Identify at least one small cleanup opportunity
  3. Apply the appropriate specialized skill
  4. Note the improvement made (e.g., "Also cleaned up: renamed x to results for clarity")

When reviewing code:

  1. Load typescript-clean-code for comprehensive rule checking
  2. Flag violations by rule number
  3. Suggest incremental improvements, not complete rewrites

The Boy Scout Promise

Every piece of code you touch gets a little better. Not perfect-just better.

Over time, better compounds into excellent.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.