From 912ccc4bf4a0a6e43226d3b4e86d859d5e51fff2 Mon Sep 17 00:00:00 2001 From: Nate Goldman <427322+ungoldman@users.noreply.github.com> Date: Sun, 5 Jul 2026 19:30:39 -0700 Subject: [PATCH 1/3] docs: add agent guidelines --- AGENTS.md | 11 +++++++++++ CLAUDE.md | 1 + 2 files changed, 12 insertions(+) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..f939b5f --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,11 @@ +# Agent Guidelines + +- install: `npm install` +- test: `npm test` +- coverage: `npm run coverage` + +Release automated by `.github/workflows/release.yml`, do not alter version. + +Follow all coding and commit conventions in `CONTRIBUTING.md`. + +Omit AI attribution in commits (Co-authored-by). Polluting git history with AI advertising is not allowed. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 0000000..47dc3e3 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file From edb799b702dbf1ac990225beb877ebdf1527ddf2 Mon Sep 17 00:00:00 2001 From: Nate Goldman <427322+ungoldman@users.noreply.github.com> Date: Sun, 5 Jul 2026 19:31:40 -0700 Subject: [PATCH 2/3] docs: add coding guidelines to contributing --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f363d4..b17757c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,3 +21,12 @@ This project welcomes any kind of contribution! Here are a few suggestions: - **Copy editing**: fix typos, clarify language, and generally improve the quality of the content. - **Formatting**: help keep content easy to read with consistent formatting. - **Code**: help maintain and improve the project codebase. + +## Coding Guidelines + +- Commits should be atomic and adhere to [conventional commit](https://conventionalcommits.org) standards. +- Commit messages should be short (`: `, 50 char max), and commit bodies only included when necessary for complex changes (72 char max). +- Breaking changes are discouraged, and require a `BREAKING CHANGE:` footer in the commit body explaining the change. +- Types and interfaces should be inlined unless they're absolutely necessary for exporting or testing. +- Avoid unnecessary code comments, and keep necessary ones trim. +- All changes should maintain the test coverage gate (100%). From 610338c8a6de7723c66fb0aaba39c66b56f642d3 Mon Sep 17 00:00:00 2001 From: Nate Goldman <427322+ungoldman@users.noreply.github.com> Date: Sun, 5 Jul 2026 19:31:40 -0700 Subject: [PATCH 3/3] docs: use https for covenant link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b17757c..caecdfa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ This project is intended to be a safe, welcoming space for collaboration. -All contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +All contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct. Thank you for being kind to each other!