koteitankoteitan/my-skills/skills/my-github-md-rule/SKILL.md

my-github-md-rule

Skill1 starsChanged 3 months agoMITView on GitHub

Apply the user's selected README language and navigation-link convention. Use only when the user explicitly asks to use `my-github-md-rule` (including `$my-github-md-rule`) in the current request; do not trigger merely because the request concerns GitHub or Markdown documentation.

In this repository15 other files it gives its agents.
- autonomy-statSkill
- check-usageSkill
- compact-unfreezeSkill
- edit-statuslineSkill
- formalization-statement-fidelity-auditSkill
- get-contextSkill
- github-math-checkSkill
- heart-beatSkill
- manim-ttsSkill
- mermaidSkill
- nostrSkill
- sessiondbSkill
- use-bmsSkill
- use-fandomSkill
- webapp-defaultsSkill

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
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

Distinctive:
Only modes 1--4 are active invocations of this skill.
line 26
Distinctive:
Keep the contents of both files equivalent in modes 3 and 4.
line 34
Distinctive:
Treat README.md as the main file GitHub renders by default.
line 35

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

GitHub Markdown Rules

Apply this skill only after the user explicitly invokes my-github-md-rule.

Select a mode

Accept a mode by number or name. If the user explicitly invokes the skill without selecting a mode, ask them to choose mode 1, 2, 3, or 4 before generating files.

No.	Mode	`README.md`	`README-ja.md`	`README-en.md`	Back link
0	default	Japanese	no	no	no
1	Japanese only	Japanese	no	no	yes
2	English only	English	no	no	yes
3	Japanese main	Japanese	no	English	yes
4	English main	English	Japanese	no	yes

Mode 0 describes normal behavior when the user does not invoke this skill. Do not apply any skill-specific file pairing, naming, or navigation-link rule in mode 0.

Only modes 1--4 are active invocations of this skill.

Generate files

In mode 1, generate only README.md in Japanese.
In mode 2, generate only README.md in English.
In mode 3, generate README.md in Japanese and README-en.md in English.
In mode 4, generate README.md in English and README-ja.md in Japanese.
Keep the contents of both files equivalent in modes 3 and 4.
Treat README.md as the main file GitHub renders by default.
For non-README documents, apply the same naming pattern: the main file is <name>.md, and the translation is <name>-en.md in mode 3 or <name>-ja.md in mode 4.

Add navigation links

In modes 1--4, put a Back link at the top of every generated Markdown file. Point it to the main README in the parent directory:

[← Back](../README.md)

In bilingual modes, add the language links on the same line:

Mode 3: [← Back](../README.md) | [English](README-en.md) | [Japanese](README.md)
Mode 4: [← Back](../README.md) | [English](README.md) | [Japanese](README-ja.md)

For non-README documents, replace the language-link filenames with the corresponding <name>.md, <name>-en.md, or <name>-ja.md filenames.

Check for cross-language link mistakes

scripts/check-link-lang.py flags links where a file's language does not match the language variant it points to -- for example a Japanese README-ja.md linking to a subdirectory's English README.md when a README-ja.md sibling exists. Navigation and language-switcher links are recognized by their text and skipped, and single-language documents (no same-language sibling on disk) are never flagged.

Pass the mode so the checker knows which suffix maps to which language:

python3 scripts/check-link-lang.py --mode 4 <path...>   # mode 4: README.md = English
python3 scripts/check-link-lang.py --mode 3 <path...>   # mode 3: README.md = Japanese

Paths may be files or directories (recursed); the default is the current directory. The checker exits 1 when it finds a mismatch and 0 otherwise. Modes 1 and 2 are single-language, so there is nothing to cross-check.

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.

Check your setup, free