Conversation
There was a problem hiding this comment.
Pull request overview
Adds an AGENTS.md guide intended to orient AI coding agents (and contributors) to the mParticle Web SDK’s architecture, workflows, and conventions.
Changes:
- Introduces a new
AGENTS.mddocument with common SDK guidance plus Web SDK–specific architecture and workflow notes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jaissica12
left a comment
jaissica12
left a comment
There was a problem hiding this comment.
Added couple of comments in Project Structure and Key Files Reference section!
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Remove line count column from Key Files Reference table - Move jest.config.js to root level in Project Structure - Add jest/*.spec.ts to test directory structure - Clarify test command as "unit tests" for better precision
alexs-mparticle
force-pushed
the
docs/no-jira-agents
branch
from
2d2239a to
dfbc0dd
Compare
- Add root level indicator for jest.config.js in project structure - Update TypeScript configuration description to be more accurate
Add .claude/ directory with skills for debugging and session management: - debug-jest: Jest/unit test failure debugging - debug-build: TypeScript/Rollup build failure debugging - debug-api: HTTP/network/API failure debugging - handoff: Session context transfer document generation - kickstart: Session initialization from handoff documents - session-recap: Quick status summaries after interruptions Also includes settings.local.json with WebFetch and GitHub CLI permissions.
jaissica12
left a comment
jaissica12
left a comment
There was a problem hiding this comment.
I’ve added a few comments, mostly non-blocking. I noticed there’s quite a bit of redundancy in the file, which could potentially cause issues over time, so I’ve left suggestions around that.
I also have mixed thoughts on the Project Structure section. My suggestion would be to try it out for a while and revisit it later if adjustments are needed.
AGENTS.md
Outdated
| # Linting | ||
| npm run lint # ESLint check (both .js and .ts files) | ||
| npm run prettier # Prettier check (.js files only) | ||
| npm run gts:check # TypeScript style check (.ts files) |
There was a problem hiding this comment.
nit: this fails for me locally. My suggestion is not to have these unless we fix the cause of failure
Fixed: Removed the gts:check and gts:fix commands since they fail when linting generated .d.ts files in dist/.
AGENTS.md
Outdated
| /.github/workflows/ # CI/CD pipelines | ||
| ``` | ||
|
|
||
| ### Code Organization Pattern |
There was a problem hiding this comment.
I think this can be removed since we have Project Structure section already exists, feels repetitive to me
Fixed: Removed the entire Code Organization Pattern section to avoid duplication with Project Structure and Testing Strategy sections.
AGENTS.md
Outdated
| └── jest/[feature].spec.ts # Jest tests (TypeScript unit tests) | ||
| ``` | ||
|
|
||
| **Testing Structure:** |
There was a problem hiding this comment.
We can keep either this OR Jest (TypeScript Unit Tests) & Karma (Browser Integration Tests) section below
Fixed: Removed this subsection as part of removing the redundant Code Organization Pattern section. The detailed Testing Strategy section below covers this.
The gts:check and gts:fix commands fail due to linting issues with generated files in dist/. Removing these commands until the gts configuration can be fixed.
This section was repetitive with the Project Structure section above and the Testing Strategy section below. Removing it makes the documentation more concise and avoids duplication.
|
|
|
||
| <!-- ============================================ --> | ||
| <!-- COMMON SECTION - Keep synced across all SDKs --> | ||
| <!-- Last Updated: 2026-02-16 --> |
|
🎉 This PR is included in version 2.58.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Background
Introduces an AGENTS.md file
What Has Changed
Screenshots/Video
Checklist
Additional Notes
Reference Issue (For employees only. Ignore if you are an outside contributor)