agentleFS
ArthurZakirovArthurZakirov/SystemSmith/skills/messaging-framework/SKILL.md

messaging-framework

Skill0 starsChanged 6 months agoMITView on GitHub

Core principles for technical communication such as commits, PR descriptions, branch names, and technical documentation. Use when writing or refining engineering-facing messaging and when other skills need a shared communication baseline.

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Do not write solution-heavy PR bodies.

    line 24

≈ “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

Messaging Framework

Core principles for writing commits, PR descriptions, branch names, and technical documentation.

Two Goals

GoalPurpose
InformHelp the reader understand and remember what the work is about
AdvertiseArgue the value so review effort feels worthwhile

The Pain-Point Pattern

Structure messages around real pain points only:

  • Observed problem
  • Downstream implication

Do not write solution-heavy PR bodies. Reviewers will inspect the diff. Do not add test plan sections just to restate what is already visible in the changes.

Pain points should describe actual experience such as errors, duplicated workflows, expensive processes, or confusing behavior, plus the consequence.

BadGood
"No common interface""Local-dev orchestration duplicated across environments, so copies drifted out of sync"
"Lost error context""Backend failures were mapped to the wrong outcome, so technical errors looked like domain results"

Sentence Structure

Prefer:

  • "[Verb] benefit by mechanism"
  • "[Verb] mechanism for benefit"

Examples:

  • "speed up local dev by automating config and log formatting"
  • "prevent data loss by fixing the asset sync race"

Format By Artifact

ArtifactFormatLength
Branch nameTICKET/short-descriptionShort
Commit subjectTICKET: type(scope): verb benefit by mechanism<=100 chars
Commit bodyPain points onlyMedium
PR titleSame as commit subjectShort
PR descriptionPain points plus one-line approachMedium

Anti-Patterns

  • "Add feature"
  • "Fix bug"
  • "Refactor code"
  • "Update dependencies"
  • Solution checklists in PR bodies
  • Generic abstractions instead of observed problems

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.