-
Notifications
You must be signed in to change notification settings - Fork 3
chore: add information-exposure policy for public repo #22
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,16 @@ | ||
| --- | ||
| description: "Public-repo information exposure policy: what never goes into commits, PRs, code, or fixtures" | ||
| globs: [] | ||
| alwaysApply: true | ||
| --- | ||
|
|
||
| # Information Exposure (public repository) | ||
|
|
||
| This repository is public. Hard rules for everything written here — commit messages, PR text, code, docs, and fixtures: | ||
|
|
||
| - NO internal content: ticket/Slack/meeting excerpts, customer or organization names, employee emails, internal URLs (Linear, Notion, Slack, Grain), internal hostnames, AWS account IDs, or infrastructure details. | ||
| - NO security detail in commit/PR text: never name the vulnerability class or exploit path; use neutral wording ("harden input validation"). | ||
| - NO secrets anywhere: tokens, API keys, JWTs, cookies, connection strings — including test fixtures and recorded HTTP mocks. | ||
| - NO AI/agent attribution: no `Co-authored-by` / `Generated-with` trailers; commit as the user's configured git identity. | ||
|
|
||
| Full policy: see `AGENTS.md`. | ||
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,31 @@ | ||
| # Agent Guidelines | ||
|
|
||
| ## Public repository — information exposure policy | ||
|
|
||
| This repository is public. Everything in it — source code, commit messages, PR titles and bodies, issues, and the CHANGELOG — is world-readable. Follow these rules for anything you write here. | ||
|
|
||
| ### Commits and pull requests | ||
|
|
||
| - Describe what changed and why it matters to users of the CLI, not the internal discussion behind it. | ||
| - Never paste content from internal tickets, Slack threads, meeting notes, or call recordings. | ||
| - Never mention customer or organization names, employee names or emails, or internal URLs (Linear, Notion, Slack, Grain). | ||
| - Never reference internal hostnames, AWS account IDs, environment names, or infrastructure topology. | ||
|
|
||
| ### Security wording | ||
|
|
||
| - Never name a vulnerability class, exploit path, or impact in commit or PR text (e.g., "fix injection in X endpoint"). | ||
| - Use neutral wording instead ("harden input validation", "improve request handling") and keep the details in the private tracker. | ||
|
|
||
| ### Secrets | ||
|
|
||
| - Never include tokens, API keys, JWTs, cookies, or connection strings anywhere: messages, code, examples, test fixtures, or recorded HTTP mocks. | ||
| - If a secret lands in history, treat it as compromised: rotate it and tell the maintainers. Deleting the line is not enough. | ||
|
|
||
| ### No AI attribution | ||
|
|
||
| - No `Co-authored-by`, `Generated-with`, `Made-with`, or any other agent/tool trailer in commits or PRs. | ||
| - Commits are authored by the user's configured git identity. Never change `git config user.name` / `user.email`. | ||
|
|
||
| ### Source is public too | ||
|
|
||
| The same rules apply inside the code: comments, docstrings, error strings, and CHANGELOG entries. Examples in the README and tests use fake organization names and `example.com` emails — never real customer data. |
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.
Verdict: Reviewed information-exposure policy and agent guidelines for public repository. Both files establish clear rules for commits, PRs, code, and fixtures: no internal content (tickets, customer names, employee emails, internal URLs), no security details in commit text, no secrets anywhere, and no AI attribution trailers.
These are advisory rules documented in
.cursor/rules(scanned by Cursor IDE) andAGENTS.md(human-readable). The policy is well-scoped and unambiguous. Residual risk: enforcement depends on code-review discipline and maintainer adoption — no automated CI hook or git hook blocks a violation at commit time. Recommend adding a pre-commit hook or CI check to scan for common patterns (hardcoded tokens, internal domain names, ticket IDs) if this becomes a recurring issue.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.
Not actioned — residual pre-commit/CI scanner is out of scope for this docs-only PR. Policy is advisory by design; a hook can land later if violations recur.