Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,30 @@ stale, rather than this file, which can. For the rest see `README.md` (install a
`CONTRIBUTING.md` (build, test and PR conventions) and the
[Events API docs](https://docs.mparticle.com/developers/server/http/).

## 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.

## Working rules

A Java client for mParticle's **server-side** Events API, published to Maven Central. Treat it as a
Expand Down
Loading