Skip to content

[Docs] Clarify public technical detail guidance #1121

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.

Sign up for GitHub

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

Closed
roomote-roomote wants to merge 1 commit into from
Closed

[Docs] Clarify public technical detail guidance #1121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ This repository is open source. Treat GitHub and other public surfaces as fully

- Do not put customer names, customer data, private deployment details, secrets, credentials, or internal maintainer discussion into commits, PR titles/bodies, PR/issue comments, review replies, or other public artifacts.
- Prefer private channels (for example Slack or the task UI) for anything that is customer-specific, confidential, or only meaningful as internal discussion.
- When writing public text, keep it general enough for an open-source audience and omit private context even when it was available in the private task thread.
- Withhold information based on whether the information itself is sensitive, not merely because it appeared in a private task thread. Public artifacts should still include useful, non-sensitive technical details such as public URLs, error messages, stack traces, file paths, commands, and validation results.
- Redact only the sensitive portions of otherwise useful technical details (for example credentials in a URL or customer data in an error) rather than omitting the entire detail.

## Setup

Expand Down
Loading