Skip to content

Commit 9e4c8e4

Browse files
Add guardrails for example-only documentation data (#704)
* Add guardrails for example-only documentation data * only use example.com
1 parent 8250156 commit 9e4c8e4

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,14 @@ impl core::error::Error for MyError {}
209209
- Format messages with present-tense verbs.
210210
- Use `log-fastly` as the backend for Fastly Compute.
211211

212+
## Other guidelines
213+
214+
- Use only example or fictional information in comments, tests, docs, examples,
215+
and similar non-runtime materials. (eg. for urls use: example.com domains only)
216+
- Do not write or commit real domains, customer names, credentials,
217+
configuration values, or other potentially sensitive real-world information in
218+
comments, tests, docs, or examples.
219+
212220
---
213221

214222
## Git Commit Conventions
@@ -382,6 +390,7 @@ both runtime behavior and build/tooling changes.
382390
- Do not use `unwrap()` in production code — use `expect("should ...")`.
383391
- Do not use thiserror — use `derive_more::Display` + `impl Error`.
384392
- Do not use wildcard imports (except `use super::*` in test modules).
385-
- Do not commit `.env` files or secrets.
393+
- Do not commit `.env` files, secrets, or potentially sensitive real-world
394+
information in comments, tests, docs, examples, or configuration files.
386395
- Do not make large refactors without approval.
387396
- Always run tests and linting before committing.

0 commit comments

Comments
 (0)