agentleFS
ARM-softwareARM-software/CMSIS_6/.github/copilot-instructions.md

CMSIS_6

Copilot instructions486 starsChanged 6 months agoApache-2.0View on GitHub

The CMSIS Core version is defined in multiple places that must always be kept in sync: Whenever a pull request modifies any of these files, verify that the version is consistent across the related locations and remind the author to update missing synchronized locations. The version check must be done per device profile (A, M, R): Additional synchronization rules: - Cortex-M (ARMv6_7_8-M Device): - Cversion in ARM.CMSIS.pdsc ↔ __CM_CMSIS_VERSION_MAIN/__CM_CMSIS_VERSION_SUB ↔ PROJECT_NUMBER in Core.dxy.in ↔ version row in Core/src/history.md. - Cortex-A…

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,336 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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. Very specific:

    Check synchronization only between ARM.CMSIS.pdsc and cmsis_version.h (__CR_* macros).

    line 38
  2. Very specific:

    Only the first two Cversion components are checked against cmsis_version.h.

    line 40

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 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

Copilot Code Review Instructions

CMSIS Core version consistency

The CMSIS Core version is defined in multiple places that must always be kept in sync:

  1. ARM.CMSIS.pdsc (repo root) — three specific <component Cclass="CMSIS" Cgroup="CORE"> entries, each identified by its condition attribute:
    • condition="ARMv6_7_8-M Device" → Cortex-M component (maps to __CM_ macros)
    • condition="ARMv7_8-A Device" → Cortex-A component (maps to __CA_ macros)
    • condition="ARMv7-R Device" → Cortex-R component (maps to __CR_ macros)
  2. CMSIS/Core/Include/cmsis_version.h — the preprocessor defines, grouped by device profile:
    • __CM_CMSIS_VERSION_MAIN / __CM_CMSIS_VERSION_SUB (Cortex-M)
    • __CA_CMSIS_VERSION_MAIN / __CA_CMSIS_VERSION_SUB (Cortex-A)
    • __CR_CMSIS_VERSION_MAIN / __CR_CMSIS_VERSION_SUB (Cortex-R)
  3. CMSIS/Documentation/Doxygen/Core/Core.dxy.in — PROJECT_NUMBER for Cortex-M documentation.
  4. CMSIS/Documentation/Doxygen/Core_A/Core_A.dxy.in — PROJECT_NUMBER for Cortex-A documentation.
  5. CMSIS/Documentation/Doxygen/Core/src/history.md — revision table row for Cortex-M version changelog.
  6. CMSIS/Documentation/Doxygen/Core_A/src/history.md — revision table row for Cortex-A version changelog.

Whenever a pull request modifies any of these files, verify that the version is consistent across the related locations and remind the author to update missing synchronized locations.

The version check must be done per device profile (A, M, R):

ARM.CMSIS.pdsc component (condition)cmsis_version.h macros
Cversion on condition="ARMv6_7_8-M Device"first component → __CM_CMSIS_VERSION_MAIN, second component → __CM_CMSIS_VERSION_SUB
Cversion on condition="ARMv7_8-A Device"first component → __CA_CMSIS_VERSION_MAIN, second component → __CA_CMSIS_VERSION_SUB
Cversion on condition="ARMv7-R Device"first component → __CR_CMSIS_VERSION_MAIN, second component → __CR_CMSIS_VERSION_SUB

Additional synchronization rules:

  • Cortex-M (ARMv6_7_8-M Device):
    • Cversion in ARM.CMSIS.pdsc ↔ __CM_CMSIS_VERSION_MAIN/__CM_CMSIS_VERSION_SUB ↔ PROJECT_NUMBER in Core.dxy.in ↔ version row in Core/src/history.md.
  • Cortex-A (ARMv7_8-A Device):
    • Cversion in ARM.CMSIS.pdsc ↔ __CA_CMSIS_VERSION_MAIN/__CA_CMSIS_VERSION_SUB ↔ PROJECT_NUMBER in Core_A.dxy.in ↔ version row in Core_A/src/history.md.
  • Cortex-R (ARMv7-R Device):
    • Check synchronization only between ARM.CMSIS.pdsc and cmsis_version.h (__CR_* macros). No documentation synchronization is required yet.

Only the first two Cversion components are checked against cmsis_version.h. If Cversion includes a third patch/revision component (for example, 6.2.0), treat it as intentionally not mapped in cmsis_version.h unless a corresponding patch/revision macro is added and documented.

For example, if Cversion="6.2.0" for the ARMv6_7_8-M Device component, then __CM_CMSIS_VERSION_MAIN must be 6 and __CM_CMSIS_VERSION_SUB must be 2; the trailing .0 is not checked by these instructions. Each profile's version must be checked independently.

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.