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.
AGENTS.md
Outdated
There was a problem hiding this comment.
The Key Files Reference table lists mp-instance.ts as "~61K" lines, but the current file is ~1.6K lines. This looks stale and may confuse contributors; please update the line count (or remove line counts if they’re expected to drift).
| | Feature | Main Files | Line Count | | |
| |---------|-----------|------------| | |
| | Entry Point | `mparticle-instance-manager.ts` | Entry | | |
| | Core Instance | `mp-instance.ts` | ~61K | | |
| | Identity | `identity.js`, `identity-utils.ts`, `identity.interfaces.ts` | 1,749+ | | |
| | Feature | Main Files | Size | | |
| |---------|-----------|------| | |
| | Entry Point | `mparticle-instance-manager.ts` | Entry / Small | | |
| | Core Instance | `mp-instance.ts` | Large | | |
| | Identity | `identity.js`, `identity-utils.ts`, `identity.interfaces.ts` | Medium | |
AGENTS.md
Outdated
There was a problem hiding this comment.
Here are the updated line counts:
| Entry Point | mparticle-instance-manager.ts | ~500 |
| Core Instance | mp-instance.ts | ~1.6K |
| Identity | identity.js, identity-utils.ts, identity.interfaces.ts | ~2.3K |
As discussed in person I believe we should not be adding line count here
|
|
||
| ### Project Structure | ||
|
|
||
| ``` |
There was a problem hiding this comment.
We should add something like this to match current project structure above /src/
/ # Repo root
jest.config.js # Jest config for TypeScript unit tests
and remove jest.config.js from line 200
AGENTS.md
Outdated
There was a problem hiding this comment.
lets remove this jest.config.js based on above comment
AGENTS.md
Outdated
There was a problem hiding this comment.
Lets also add
jest/*.spec.ts # Jest unit tests
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!
AGENTS.md
Outdated
There was a problem hiding this comment.
#Jest unit tests only (TypeScript)
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
|
2 participants
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)