agentleFS
sunshineluyaosunshineluyao/Moss-Mcp-Transaction/.github/copilot-instructions.md

Moss-Mcp-Transaction

Copilot instructions1 starsChanged 3 months agoMITView on GitHub

Notes: - Do not use alternatives like YES/NO unless space constraints force it. - Do not misspell RPC as PRC. - Keep System Error as a phrase; do not split into separate terms unless required by layout.

The file

Show its rules and text

We split this copilot-instructions.md into the rules it gives an agent

20 rules. About 0 are common, 13 are distinctive, and 7 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈13

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 7

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Do not put long text on edges.

    line 8
  2. Distinctive:

    Avoid inline edge labels whenever possible.

    line 9
  3. Distinctive:

    If an edge label is required, keep it one word and single-line.

    line 10
  4. Distinctive:

    Prefer moving explanatory text into nodes.

    line 11
  5. Very specific:

    Do not use <br/> inside edge labels.

    line 12
  6. Very specific:

    Keep decision labels short: Yes, No, Retry, Back.

    line 13
  7. Very specific:

    Keep transition labels short: Sign, Reject, Revert, Error.

    line 14
  8. Distinctive:

    If clipping appears, first shorten/remove edge labels.

    line 16
  9. Distinctive:

    Only after label shortening, adjust spacing values:

    line 17
  10. Very specific:

    If GitHub still clips text, force short line breaks inside nodes (for example System<br/>Error, React<br/>UI) and increase diagramPadding.

    line 21
  11. Very specific:

    Do not use alternatives like YES/NO unless space constraints force it.

    line 32
  12. Very specific:

    Do not misspell RPC as PRC.

    line 33
  13. Very specific:

    Keep System Error as a phrase.

    line 34
  14. Distinctive:

    Keep English and Chinese diagram logic synchronized.

    line 38
  15. Distinctive:

    Keep node and edge counts aligned across EN/ZH versions.

    line 39
  16. Distinctive:

    Prefer stable GitHub-compatible Mermaid syntax.

    line 40
  17. Distinctive:

    Avoid advanced Mermaid features that render inconsistently on GitHub.

    line 41
  18. Distinctive:

    Put details in node text blocks.

    line 45
  19. Distinctive:

    Keep arrows mostly unlabeled.

    line 46
  20. Distinctive:

    Use labels only for critical branch decisions.

    line 47

≈ “Common” is an estimate: at least 1 in 5 of the 3,827 Copilot instructions 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
copilot-instructions.md

Repository Copilot Instructions

Scope

These rules apply when generating or editing Mermaid diagrams, especially in README files.

Mermaid Anti-Clipping Rules (GitHub Renderer)

  1. Do not put long text on edges.
  2. Avoid inline edge labels whenever possible.
  3. If an edge label is required, keep it one word and single-line.
  4. Prefer moving explanatory text into nodes.
  5. Do not use <br/> inside edge labels.
  6. Keep decision labels short: Yes, No, Retry, Back.
  7. Keep transition labels short: Sign, Reject, Revert, Error.
  8. For Chinese labels, keep to 2-4 characters where possible.
  9. If clipping appears, first shorten/remove edge labels.
  10. Only after label shortening, adjust spacing values:
  • increase nodeSpacing slightly
  • increase rankSpacing slightly
  1. For status diagrams, prefer plain single-line node labels (no emoji, no <br/>) for: Pending, System Error, Awaiting Signature.
  2. If GitHub still clips text, force short line breaks inside nodes (for example System<br/>Error, React<br/>UI) and increase diagramPadding.

Canonical Terminology (Use Exactly)

  • Yes
  • No
  • Pending
  • System Error
  • UI

Notes:

  • Do not use alternatives like YES/NO unless space constraints force it.
  • Do not misspell RPC as PRC.
  • Keep System Error as a phrase; do not split into separate terms unless required by layout.

README Diagram Editing Checklist

  • Keep English and Chinese diagram logic synchronized.
  • Keep node and edge counts aligned across EN/ZH versions.
  • Prefer stable GitHub-compatible Mermaid syntax.
  • Avoid advanced Mermaid features that render inconsistently on GitHub.

Preferred Pattern

  • Put details in node text blocks.
  • Keep arrows mostly unlabeled.
  • Use labels only for critical branch decisions.

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.