Skip to content

Commit 6891515

Browse files
authored
docs: add agent guidelines and coding conventions (#72)
* docs: add agent guidelines * docs: add coding guidelines to contributing * docs: use https for covenant link * ci: cancel superseded workflow runs
1 parent 7a9e5ab commit 6891515

4 files changed

Lines changed: 26 additions & 1 deletion

File tree

.github/workflows/tests.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ on:
66
branches:
77
- main
88

9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
913
jobs:
1014
test:
1115
runs-on: ${{ matrix.os }}

AGENTS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Agent Guidelines
2+
3+
- install: `npm install`
4+
- test: `npm test`
5+
- coverage: `npm run coverage`
6+
7+
Release automated by `.github/workflows/release.yml`, do not alter version.
8+
9+
Follow all coding and commit conventions in `CONTRIBUTING.md`.
10+
11+
Omit AI attribution in commits (Co-authored-by). Polluting git history with AI advertising is not allowed.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This project is intended to be a safe, welcoming space for collaboration.
66

7-
All contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
7+
All contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
88

99
Thank you for being kind to each other!
1010

@@ -21,3 +21,12 @@ This project welcomes any kind of contribution! Here are a few suggestions:
2121
- **Copy editing**: fix typos, clarify language, and generally improve the quality of the content.
2222
- **Formatting**: help keep content easy to read with consistent formatting.
2323
- **Code**: help maintain and improve the project codebase.
24+
25+
## Coding Guidelines
26+
27+
- Commits should be atomic and adhere to [conventional commit](https://conventionalcommits.org) standards.
28+
- Commit messages should be short (`<topic>: <action>`, 50 char max), and commit bodies only included when necessary for complex changes (72 char max).
29+
- Breaking changes are discouraged, and require a `BREAKING CHANGE:` footer in the commit body explaining the change.
30+
- Types and interfaces should be inlined unless they're absolutely necessary for exporting or testing.
31+
- Avoid unnecessary code comments, and keep necessary ones trim.
32+
- All changes should maintain the test coverage gate (100%).

0 commit comments

Comments
 (0)