Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.75 KB

File metadata and controls

25 lines (16 loc) · 1.75 KB

AGENTS.md

Guidance for AI coding agents working in this repository. This is the tool-agnostic summary; CLAUDE.md holds the full detail and takes precedence where the two overlap.

What this repo is

GitHub's special .github repository for the @perishdev organization. It holds community health files and the org profile page. There is no application code, no build system, and no test suite — do not scaffold one.

Rules that are easy to get wrong

  1. Blast radius. Community health files (SECURITY.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SUPPORT.md, GOVERNANCE.md, and the issue/PR/discussion templates) are inherited by every repo in the org that lacks its own copy. A change here silently changes the default everywhere.
  2. Absolute links only in inherited files. Use https://github.com/perishdev/... URLs, never relative paths — relative links break when GitHub renders the file in another repo's context.
  3. Not inherited: FUNDING.yml and .github/workflow-templates/ affect only this repo. FUNDING.yml here is a commented reference template.
  4. No default license is possible; the repo-level LICENSE stands alone.

Conventions

Before you edit

Read CLAUDE.md for the full layout and rationale. When editing an inherited file, consider every downstream repo, not just this one.