Skip to content

docs: add CLAUDE.md #9

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

Merged
govindkavaturi-art merged 3 commits into from
Mar 31, 2026
Merged

docs: add CLAUDE.md #9

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa87c46
ci: trigger sdk-integration to verify dependency fix
Mar 31, 2026
caa92fe
docs: add CLAUDE.md with branch protection and security rules
Mar 31, 2026
f524ed9
Merge branch 'main' into docs/add-claude-md
govindkavaturi-art Mar 31, 2026
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
22 changes: 22 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# CLAUDE.md - Rules for AI agents working on this repo

## Branch protection
- Never bypass branch protection or force merge failing checks
- Never use --no-verify or skip pre-commit hooks
- All changes to main must pass required status checks (sdk-integration, staging-integration)
- If a check fails, fix the root cause before merging

## Publishing
- PyPI publish triggers only on version tags (v*)
- Uses trusted publishing (OIDC) - no API tokens
- Never store PYPI_TOKEN in source or secrets

## Security
- Never hardcode API keys, secrets, or tokens in source code
- Use environment variables or GitHub secrets for all credentials
- All GitHub Actions must be pinned to commit SHAs, not version tags
- Staging keys go in CUEAPI_STAGING_API_KEY GitHub secret, never in code

## Code quality
- Run tests locally before pushing: pytest tests/ -v
- Do not use em dashes in any user-facing content
Loading