Repository navigation
docs: add agent instructions with public repository confidentiality rules #128
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
Merged
Merged
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,27 @@ | ||
| # mParticle Flutter SDK - Agent Instructions | ||
|
|
||
| A Flutter plugin that exposes the mParticle API on iOS, Android and web. `README.md` covers integration. | ||
|
|
||
| ## This is a PUBLIC repository | ||
|
|
||
| Everything pushed here is world-readable and permanent: code, comments, commit messages, branch | ||
| names, PR titles and descriptions, review comments, test names, fixtures and assets. Closing a | ||
| PR, renaming a branch or force-pushing does not take any of it back, because GitHub keeps a | ||
| closed PR's original branch name and commits. The first push is the one that counts. | ||
|
|
||
| Never include: | ||
|
|
||
| - Partner, client or advertiser names, or any detail that could identify one (account, tenant | ||
| or campaign IDs, deal terms, integration specifics). Say "a partner" or use a synthetic | ||
| example, in branch names too. | ||
| - Partner brand assets: logos, screenshots or copy. Demo and sample content uses fictional | ||
| brands. | ||
| - Internal service, system or class names, internal hostnames, dashboards, or links to private | ||
| repos and tickets. | ||
| - Backend detail, especially how a payload is validated server-side. Describe what the SDK | ||
| sends and receives, in partner-facing terms, and refer to a server change generically ("to | ||
| match the server contract"). | ||
|
|
||
| Before each push, PR, comment or reply, read the exact outgoing text, branch name included. If | ||
| you are unsure whether a detail is safe, leave it out and ask privately. Do not publish first | ||
| and edit it out later. | ||
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,5 @@ | ||
| # mParticle Flutter SDK - Agent Instructions | ||
|
|
||
| <!-- Claude Code reads CLAUDE.md, not AGENTS.md. Keep all guidance in AGENTS.md. --> | ||
|
|
||
| @AGENTS.md |
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.
Uh oh!
There was an error while loading. Please reload this page.