docs: add AI rules files and contributor documentation#22
Merged
Conversation
- CLAUDE.md (root) — AI assistant context: repo purpose, structure, versioning contract, CI/release triggers, key conventions - .cursorrules — symlink → CLAUDE.md (Cursor support) - .github/copilot-instructions.md — symlink → ../CLAUDE.md (Copilot support) - documentation/CONTRIBUTING.md — contributor entry point with links to guides - documentation/ADDING_AN_ACTION.md — step-by-step: new action checklist - documentation/UPDATING_AN_ACTION.md — versioning rules, patch/minor/major guidance - documentation/WRITING_TESTS.md — bats patterns, mock strategy, CI registration - documentation/DEVOPS.md — CI/CD overview linking to workflow docs - documentation/CODE_QUALITY.md — code-quality.yml explained - documentation/CREATE_RELEASE.md — create-release.yml explained - documentation/TESTING.md — add link to WRITING_TESTS.md - README.md — add link to CONTRIBUTING.md
- MD040: add language tag to fenced code blocks in CREATE_RELEASE.md - MD013: wrap long lines in UPDATING_AN_ACTION.md and WRITING_TESTS.md - MD060: add spaces to table separator rows across all new docs Run markdownlint locally before committing markdown.
- WRITING_TESTS.md: replace bats syntax/examples with links to bats-core docs; keep only repo-specific conventions (BATS_TEST_DIRNAME depth, mock pattern, CI registration) - ADDING_AN_ACTION.md: replace prescriptive action.yml example with link to GitHub Actions docs; keep only the two repo-specific conventions - DEVOPS.md: remove version from actions/checkout reference (avoids going stale)
jonryser
approved these changes
Mar 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds AI assistant context files and a full contributor documentation suite.
AI Rules Files
CLAUDE.md(root) — source of truth for AI context: repo purpose, structure, versioning contract, CI/release triggers.cursorrules— symlink →CLAUDE.md.github/copilot-instructions.md— symlink →../CLAUDE.mdNew Documentation
documentation/CONTRIBUTING.mddocumentation/ADDING_AN_ACTION.mddocumentation/UPDATING_AN_ACTION.mddocumentation/WRITING_TESTS.mddocumentation/DEVOPS.mddocumentation/CODE_QUALITY.mddocumentation/CREATE_RELEASE.mdUpdated
documentation/TESTING.md— links toWRITING_TESTS.md(no duplication)README.md— links toCONTRIBUTING.md