Skip to content

Add guardrails for example-only documentation data #704

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

Open
ChristianPavilonis wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −1
Open

Add guardrails for example-only documentation data #704

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
11 changes: 10 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,14 @@ impl core::error::Error for MyError {}
- Format messages with present-tense verbs.
- Use `log-fastly` as the backend for Fastly Compute.

## Other guidelines

- Use only example or fictional information in comments, tests, docs, examples,
and similar non-runtime materials.
- Do not write or commit real domains, customer names, credentials,
configuration values, or other potentially sensitive real-world information in
comments, tests, docs, or examples.

---

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