Skip to content

Refine AI context files#96

Open
ai-coding-guardrails[bot] wants to merge 1 commit intomainfrom
chore/zenable-refine-context
Open

Refine AI context files#96
ai-coding-guardrails[bot] wants to merge 1 commit intomainfrom
chore/zenable-refine-context

Conversation

@ai-coding-guardrails
Copy link
Copy Markdown

This PR contains suggested improvements to AI context files.

Refinement effort: Balanced (level 3/5)

Summary

CLAUDE.md

Five issues found: (1) Missing security requirement for cryptographic secret keys refusing to start in production without a key. (2) Missing requirement to never log sensitive values in clear text — the 'use logging liberally' advice is actively dangerous without this caveat. (3) Missing requirement for authorization logic to be fully implemented. (4) Missing requirement to use a centralized constants file for enums. (5) The Best Practices code block uses deprecated typing imports (List, Optional) incompatible with the project's Python 3.13+ target, and is excessively verbose for what it conveys.

  • 1 suggested edits

CONTRIBUTING.md

The file is a developer-facing CONTRIBUTING.md that is missing any security or coding-standards guidance. It does not mention the three key requirements: (1) no clear-text logging of sensitive values, (2) SECRET_KEY must not silently fall back to an ephemeral value in production, and (3) enum constants must come from a centralized constants file. Additionally, the file is somewhat verbose with redundant bash examples. The suggested edit adds a concise Security guidelines section and restructures the content for skimmability.

  • 1 suggested edits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants