Skip to content

Commit 7949598

Browse files
mattbodleclaude
andcommitted
docs: Add AGENTS.md with branch naming and CI guidelines
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a1111c8 commit 7949598

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Agent Guidelines
2+
3+
Instructions for AI agents working on this repository.
4+
5+
## Branch Naming
6+
7+
Branch names **must** start with one of the following prefixes (enforced by CI):
8+
9+
- `build/`
10+
- `chore/`
11+
- `ci/`
12+
- `docs/`
13+
- `feat/`
14+
- `fix/`
15+
- `perf/`
16+
- `refactor/`
17+
- `revert/`
18+
- `style/`
19+
- `test/`
20+
21+
Use the prefix that matches the type of change (e.g., `feat/adblock-measurement`, `fix/iframe-cleanup`). This aligns with the conventional commit types documented in `CONTRIBUTING.md`.
22+
23+
## Git Push (SAML SSO)
24+
25+
The `mparticle-integrations` GitHub org enforces SAML SSO. SSH push will fail. To push:
26+
27+
1. Run `gh auth setup-git` to configure the git credential helper.
28+
2. Temporarily switch the remote to HTTPS: `git remote set-url origin https://github.com/mparticle-integrations/mparticle-javascript-integration-rokt.git`
29+
3. Push the branch.
30+
4. Restore the SSH remote: `git remote set-url origin git@github.com:mparticle-integrations/mparticle-javascript-integration-rokt.git`
31+
32+
## Running Tests
33+
34+
```bash
35+
npm install
36+
npm test -- --browsers ChromeHeadless # FirefoxHeadless may not be available
37+
```
38+
39+
## Linting
40+
41+
```bash
42+
npm run lint # check
43+
npm run lint:fix # auto-fix
44+
```
45+
46+
Always run lint before pushing. The CI enforces Prettier formatting.

0 commit comments

Comments
 (0)