Skip to content

docs: add AGENTS.md coding guide - #596

Closed
ehsavoie wants to merge 1 commit into
a2aproject:mainfrom
ehsavoie:agents_md
Closed

ehsavoie wants to merge 1 commit into
a2aproject:mainfrom
ehsavoie:agents_md

docs: Add AGENTS.md guide and enhance extras documentation

cf28aee
Select commit
Loading
Failed to load commit list.
This check has been archived and is scheduled for deletion. Learn more about checks retention
In Solidarity / Inclusive Language succeeded Jan 19, 2026 in 2s

Check completed with success

Configuration

Below is the configuration used for this check run:

rules:
  master:
    regex:
      - /master/gi
    level: warning
    alternatives:
      - primary
      - main
      - leader
      - active
      - writer
  slave:
    regex:
      - /slave/gi
    level: warning
    alternatives:
      - secondary
      - node
      - worker
      - replica
      - passive
  whitelist:
    regex:
      - /white[_-]*list/gi
    level: warning
    alternatives:
      - include list
      - allow list
  blacklist:
    regex:
      - /black[_-]*list/gi
    level: warning
    alternatives:
      - exclude list
      - deny list
  grandfathered:
    regex:
      - /grandfathered/gi
    level: 'off'
    alternatives:
      - legacied
      - exempted
  sanity_check:
    regex:
      - /sanity[_-]*check/gi
    level: 'off'
    alternatives:
      - smoke test
      - confidence check
  man_hours:
    regex:
      - /man[_-]*hours/gi
    level: 'off'
    alternatives:
      - person-hours
      - human-hours
ignore:
  - .github/in-solidarity.yml
defaultMessage: >

  Please consider an alternative to `{{match}}`. 

  {{#if alternatives~}}


  Possibilities include: {{#each alternatives}}{{#if @index}},
  {{/if}}`{{this}}`{{/each}}

  {{~/if}}

For more information on configuration and rules, check the documentation.

App version