Skip to content

Commit e82073c

Browse files
mattbodleclaude
andcommitted
docs: Add AGENTS.md with repo conventions for AI agents
Reference CONTRIBUTING.md for branch naming and commit types. Document SAML SSO push workaround, test commands, and build artifact policy. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 4f7224a commit e82073c

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Agent Guidelines
2+
3+
Instructions for AI agents working on this repository.
4+
5+
## Branch Naming and Commit Conventions
6+
7+
Branch names must use a conventional commit prefix (e.g., `feat/`, `fix/`, `chore/`). This is enforced by CI. See `CONTRIBUTING.md` for the full list of allowed types and commit message format.
8+
9+
## Do Not Commit Build Artifacts
10+
11+
The `dist/` folder, `CHANGELOG.md`, and version bumps in `package.json`/`package-lock.json` are all generated by the CI/CD release process. Only commit changes to source (`src/`) and test (`test/`) files.
12+
13+
## Git Push (SAML SSO)
14+
15+
The `mparticle-integrations` GitHub org enforces SAML SSO. SSH push will fail. To push:
16+
17+
1. Run `gh auth setup-git` to configure the git credential helper.
18+
2. Temporarily switch the remote to HTTPS: `git remote set-url origin https://github.com/mparticle-integrations/mparticle-javascript-integration-rokt.git`
19+
3. Push the branch.
20+
4. Restore the SSH remote: `git remote set-url origin git@github.com:mparticle-integrations/mparticle-javascript-integration-rokt.git`
21+
22+
## Running Tests
23+
24+
```bash
25+
npm install
26+
npm test -- --browsers ChromeHeadless # FirefoxHeadless may not be available
27+
```
28+
29+
## Linting
30+
31+
```bash
32+
npm run lint # check
33+
npm run lint:fix # auto-fix
34+
```
35+
36+
Always run lint before pushing. The CI enforces Prettier formatting.

0 commit comments

Comments
 (0)