-
Notifications
You must be signed in to change notification settings - Fork 1
docs: Add AGENTS.md with repo conventions for AI agents #63
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mattbodle
wants to merge
1
commit into
development
Choose a base branch
from
docs/agents-md
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # Agent Guidelines | ||
|
|
||
| Instructions for AI agents working on this repository. | ||
|
|
||
| ## Branch Naming and Commit Conventions | ||
|
|
||
| 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. | ||
|
|
||
| ## Do Not Commit Build Artifacts | ||
|
|
||
| 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. | ||
|
|
||
| ## Git Push (SAML SSO) | ||
|
|
||
| The `mparticle-integrations` GitHub org enforces SAML SSO. SSH push will fail. To push: | ||
|
|
||
| 1. Run `gh auth setup-git` to configure the git credential helper. | ||
| 2. Temporarily switch the remote to HTTPS: `git remote set-url origin https://github.com/mparticle-integrations/mparticle-javascript-integration-rokt.git` | ||
| 3. Push the branch. | ||
| 4. Restore the SSH remote: `git remote set-url origin [email protected]:mparticle-integrations/mparticle-javascript-integration-rokt.git` | ||
|
|
||
| ## Running Tests | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm test -- --browsers ChromeHeadless # FirefoxHeadless may not be available | ||
| ``` | ||
|
|
||
| ## Linting | ||
|
|
||
| ```bash | ||
| npm run lint # check | ||
| npm run lint:fix # auto-fix | ||
| ``` | ||
|
|
||
| Always run lint before pushing. The CI enforces Prettier formatting. | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we make this a skill?