docs: adopt AGENTS.md convention, include from CLAUDE.md by colonelpanic8 · Pull Request #980 · HaoboGu/rmk

colonelpanic8 · 2026-07-20T06:32:25Z

Summary

Moves the repository's agent guidance into AGENTS.md (the emerging cross-tool convention) and reduces CLAUDE.md to a single @AGENTS.md include.

This way there's one canonical guidance file that works for any agent that follows the AGENTS.md convention (Codex, Cursor, etc.), while Claude Code keeps reading the same content through CLAUDE.md's @-import.

Changes

AGENTS.md: new file, contains the previous CLAUDE.md content (header generalized from "Claude Code" to "coding agents").
CLAUDE.md: now just @AGENTS.md.

No content was otherwise changed.

🤖 Generated with Claude Code

Move the repository agent guidance into AGENTS.md so it is picked up by any tool following the AGENTS.md convention, and reduce CLAUDE.md to an `@AGENTS.md` include so Claude Code continues to read the same content. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

github-actions · 2026-07-20T06:42:43Z

Size Report

Example	main	PR	Diff	.text
`use_config/nrf52832_ble`	390.1 KiB	390.1 KiB	+0.00%	0
`use_config/nrf52840_ble`	435.3 KiB	435.3 KiB	+0.00% ⬆️	+4
`use_config/nrf52840_ble_split (central)`	489.0 KiB	489.0 KiB	+0.00% ⬇️	-4
`use_config/nrf52840_ble_split (peripheral)`	315.9 KiB	315.9 KiB	+0.00%	0
`use_config/pi_pico_w_ble`	663.3 KiB	663.4 KiB	+0.00% ⬆️	+4
`use_config/rp2040`	145.6 KiB	145.6 KiB	+0.00%	0
`use_config/rp2040_split (central)`	159.2 KiB	159.2 KiB	+0.00%	0
`use_config/rp2040_split (peripheral)`	27.8 KiB	27.8 KiB	+0.00%	0
`use_config/stm32f1`	61.8 KiB	61.8 KiB	+0.00%	0
`use_config/stm32h7`	99.0 KiB	99.0 KiB	+0.00%	0
`use_rust/nrf52832_ble`	377.3 KiB	377.3 KiB	+0.00%	0
`use_rust/nrf52840_ble`	432.0 KiB	432.0 KiB	+0.00% ⬆️	+4
`use_rust/nrf52840_ble_split (central)`	497.4 KiB	497.4 KiB	+0.00% ⬇️	-8
`use_rust/nrf52840_ble_split (peripheral)`	312.1 KiB	312.1 KiB	+0.00%	0
`use_rust/pi_pico_w_ble`	663.6 KiB	663.6 KiB	+0.00% ⬆️	+8
`use_rust/rp2040`	145.1 KiB	145.1 KiB	+0.00%	0
`use_rust/rp2040_split (central)`	158.0 KiB	158.0 KiB	+0.00%	0
`use_rust/rp2040_split (peripheral)`	28.2 KiB	28.2 KiB	+0.00%	0
`use_rust/stm32f1`	61.3 KiB	61.3 KiB	+0.00%	0
`use_rust/stm32h7`	119.6 KiB	119.6 KiB	+0.00% ⬇️	-4

use_config/nrf52832_ble — 390.1 KiB → 390.1 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 361424	   4588	  33456	 399468	  6186c	rmk-nrf52832

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 361424	   4588	  33456	 399468	  6186c	rmk-nrf52832

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
   +10%      +5  [ = ]       0    [Unmapped]
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%     -30  [ = ]       0    .strtab
  -0.7%     -54  [ = ]       0    .debug_abbrev
  -0.0%    -110  [ = ]       0    .debug_str
  -0.0%    -117  [ = ]       0    .debug_info
  -0.0%    -132  [ = ]       0    .debug_line
  -0.0%    -448  [ = ]       0    TOTAL

use_config/nrf52840_ble — 435.3 KiB → 435.3 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 394168	   4596	  47016	 445780	  6cd54	rmk-nrf52840

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 394164	   4596	  47016	 445776	  6cd50	rmk-nrf52840

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
   +67%     +26  [ = ]       0    [Unmapped]
  +0.0%      +4  +0.0%      +4    .text
  +0.0%      +2  [ = ]       0    .debug_line
  +0.0%     +32  +0.0%      +4    TOTAL

use_config/nrf52840_ble_split (central) — 489.0 KiB → 489.0 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 450516	   4652	  45536	 500704	  7a3e0	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 450520	   4652	  45536	 500708	  7a3e4	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +983  [ = ]       0    .debug_str
  +0.0%     +71  [ = ]       0    .strtab
  +0.0%     +10  [ = ]       0    .debug_loc
  +9.3%      +4  [ = ]       0    [Unmapped]
  -0.0%      -4  -0.0%      -4    .text
  +0.0% +1.04Ki  -0.0%      -4    TOTAL

use_config/nrf52840_ble_split (peripheral) — 315.9 KiB → 315.9 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 291836	   4468	  27184	 323488	  4efa0	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 291836	   4468	  27184	 323488	  4efa0	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +701  [ = ]       0    .debug_str
  +0.0%    +234  [ = ]       0    .debug_info
  +0.0%     +97  [ = ]       0    .debug_line
  +0.0%     +19  [ = ]       0    .strtab
  +0.0%     +10  [ = ]       0    .debug_loc
  -1.5%      -1  [ = ]       0    [Unmapped]
  +0.0% +1.04Ki  [ = ]       0    TOTAL

use_config/pi_pico_w_ble — 663.3 KiB → 663.4 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 625964	      0	  53308	 679272	  a5d68	rmk-pi-pico-w

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 625960	      0	  53308	 679268	  a5d64	rmk-pi-pico-w

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
   +65%     +26  [ = ]       0    [Unmapped]
  +0.0%     +10  [ = ]       0    .debug_loc
  +0.0%      +4  +0.0%      +4    .text
  -0.0%      -4  [ = ]       0    .strtab
  -0.4%     -39  [ = ]       0    .debug_abbrev
  -0.0%     -98  [ = ]       0    .debug_line
  -0.0%    -136  [ = ]       0    .debug_str
  -0.0%    -251  [ = ]       0    .debug_info
  -0.0%    -488  +0.0%      +4    TOTAL

use_config/rp2040 — 145.6 KiB → 145.6 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 134412	      0	  14724	 149136	  24690	rmk-rp2040

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 134412	      0	  14724	 149136	  24690	rmk-rp2040

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +102  [ = ]       0    .debug_str
  +0.1%     +92  [ = ]       0    .debug_line
  +0.0%     +37  [ = ]       0    .debug_info
  +0.0%     +10  [ = ]       0    .debug_loc
  +0.0%      +2  [ = ]       0    .strtab
  +2.8%      +1  [ = ]       0    [Unmapped]
  +0.0%    +244  [ = ]       0    TOTAL

use_config/rp2040_split (central) — 159.2 KiB → 159.2 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 147472	      0	  15588	 163060	  27cf4	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 147472	      0	  15588	 163060	  27cf4	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  -0.0%      -1  [ = ]       0    .debug_str
  -0.0%      -1  [ = ]       0    .strtab
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%     -12  [ = ]       0    TOTAL

use_config/rp2040_split (peripheral) — 27.8 KiB → 27.8 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  25616	     60	   2796	  28472	   6f38	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  25616	     60	   2796	  28472	   6f38	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [ = ]       0  [ = ]       0    TOTAL

use_config/stm32f1 — 61.8 KiB → 61.8 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  56540	     28	   6740	  63308	   f74c	rmk-stm32f1

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  56540	     28	   6740	  63308	   f74c	rmk-stm32f1

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [ = ]       0  [ = ]       0    TOTAL

use_config/stm32h7 — 99.0 KiB → 99.0 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  92232	    264	   8928	 101424	  18c30	rmk-stm32h7

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  92232	    264	   8928	 101424	  18c30	rmk-stm32h7

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +1.5%      +1  [ = ]       0    [Unmapped]
  -0.3%    -186  [ = ]       0    .strtab
  -0.1% -1.19Ki  [ = ]       0    .debug_str
  -0.0% -1.38Ki  [ = ]       0    TOTAL

use_rust/nrf52832_ble — 377.3 KiB → 377.3 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 349272	   4588	  32488	 386348	  5e52c	rmk-nrf52832

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 349272	   4588	  32488	 386348	  5e52c	rmk-nrf52832

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1% +3.63Ki  [ = ]       0    .debug_str
  +0.2%    +410  [ = ]       0    .strtab
  +0.0%     +10  [ = ]       0    .debug_loc
  -6.5%      -3  [ = ]       0    [Unmapped]
  +0.1% +4.04Ki  [ = ]       0    TOTAL

use_rust/nrf52840_ble — 432.0 KiB → 432.0 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 394400	   4588	  43352	 442340	  6bfe4	rmk-nrf52840

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 394396	   4588	  43352	 442336	  6bfe0	rmk-nrf52840

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1%    +310  [ = ]       0    .debug_line
  +0.0%    +208  [ = ]       0    .debug_info
  +0.0%    +110  [ = ]       0    .debug_str
  +0.5%     +39  [ = ]       0    .debug_abbrev
  +0.0%     +30  [ = ]       0    .strtab
  +0.0%     +12  [ = ]       0    .debug_loc
  +0.0%      +4  +0.0%      +4    .text
  -6.8%      -5  [ = ]       0    [Unmapped]
  +0.0%    +708  +0.0%      +4    TOTAL

use_rust/nrf52840_ble_split (central) — 497.4 KiB → 497.4 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 454252	   4652	  50464	 509368	  7c5b8	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 454260	   4652	  50464	 509376	  7c5c0	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +135  [ = ]       0    .debug_line
  +0.0%     +48  [ = ]       0    .debug_info
  +0.0%     +44  [ = ]       0    .debug_str
  +0.0%     +12  [ = ]       0    .strtab
   +19%      +9  [ = ]       0    [Unmapped]
  -0.0%      -8  -0.0%      -8    .text
  -0.0%     -12  [ = ]       0    .debug_loc
  +0.0%    +228  -0.0%      -8    TOTAL

use_rust/nrf52840_ble_split (peripheral) — 312.1 KiB → 312.1 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 289664	   4468	  25432	 319564	  4e04c	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 289664	   4468	  25432	 319564	  4e04c	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  -0.0%     -12  [ = ]       0    .debug_loc
  -0.0%     -12  [ = ]       0    TOTAL

use_rust/pi_pico_w_ble — 663.6 KiB → 663.6 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 626056	      0	  53500	 679556	  a5e84	rmk-pi-pico-w

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 626048	      0	  53500	 679548	  a5e7c	rmk-pi-pico-w

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +8  +0.0%      +8    .text
 -12.5%      -6  [ = ]       0    [Unmapped]
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%     -26  [ = ]       0    .strtab
  -0.4%     -39  [ = ]       0    .debug_abbrev
  -0.0%    -105  [ = ]       0    .debug_line
  -0.0%    -180  [ = ]       0    .debug_str
  -0.0%    -246  [ = ]       0    .debug_info
  -0.0%    -604  +0.0%      +8    TOTAL

use_rust/rp2040 — 145.1 KiB → 145.1 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 133988	      0	  14644	 148632	  24498	rmk-rp2040

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 133988	      0	  14644	 148632	  24498	rmk-rp2040

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +101  [ = ]       0    .debug_str
  +0.1%     +92  [ = ]       0    .debug_line
  +0.0%     +37  [ = ]       0    .debug_info
  +0.0%      +1  [ = ]       0    .strtab
  +2.2%      +1  [ = ]       0    [Unmapped]
  +0.0%    +232  [ = ]       0    TOTAL

use_rust/rp2040_split (central) — 158.0 KiB → 158.0 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 146356	      0	  15420	 161776	  277f0	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 146356	      0	  15420	 161776	  277f0	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +1.7%      +1  [ = ]       0    [Unmapped]
  -0.0%      -2  [ = ]       0    .strtab
  -0.0%     -46  [ = ]       0    .debug_info
  -0.0%     -70  [ = ]       0    .debug_str
  -0.1%    -143  [ = ]       0    .debug_line
  -0.0%    -260  [ = ]       0    TOTAL

use_rust/rp2040_split (peripheral) — 28.2 KiB → 28.2 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  25716	     60	   3060	  28836	   70a4	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  25716	     60	   3060	  28836	   70a4	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [ = ]       0  [ = ]       0    TOTAL

use_rust/stm32f1 — 61.3 KiB → 61.3 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  55940	     28	   6756	  62724	   f504	rmk-stm32f1

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  55940	     28	   6756	  62724	   f504	rmk-stm32f1

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [ = ]       0  [ = ]       0    TOTAL

use_rust/stm32h7 — 119.6 KiB → 119.6 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 107236	    320	  14924	 122480	  1de70	rmk-stm32h7

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 107240	    320	  14924	 122484	  1de74	rmk-stm32h7

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1%    +124  [ = ]       0    .debug_line
  +0.0%     +37  [ = ]       0    .debug_info
   +12%      +5  [ = ]       0    [Unmapped]
  -0.0%      -4  -0.0%      -4    .text
  -0.2%    -181  [ = ]       0    .strtab
  -0.1% -1.97Ki  [ = ]       0    .debug_str
  -0.0% -1.99Ki  -0.0%      -4    TOTAL

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: adopt AGENTS.md convention, include from CLAUDE.md#980

docs: adopt AGENTS.md convention, include from CLAUDE.md#980
colonelpanic8 wants to merge 1 commit into
HaoboGu:mainfrom
colonelpanic8:claude/claude-md-agents-trick-7a4fde

colonelpanic8 commented Jul 20, 2026

Uh oh!

github-actions Bot commented Jul 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

colonelpanic8 commented Jul 20, 2026

Summary

Changes

Uh oh!

github-actions Bot commented Jul 20, 2026

Size Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant