[Docs] Enforce Black Formatting in Contributor Docs#25135
Conversation
Black formatting is now enforced in CI. Update CLAUDE.md, AGENTS.md, and CONTRIBUTING.md to instruct contributors and AI agents to run `poetry run black .` before committing, and add VS Code setup guidance. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
Greptile SummaryThis PR updates
Confidence Score: 5/5Safe to merge; documentation improvements are accurate and the deleted security files are confirmed orphaned from any active workflow. All remaining findings are P2. The documentation changes are correct and the only substantive concern — undocumented file deletions — has no active CI impact since none of the deleted files are invoked by any GitHub workflow. No correctness, data-integrity, or reliability issues are present. No files require special attention beyond updating the PR description to disclose the security-file deletions.
|
| Filename | Overview |
|---|---|
| CLAUDE.md | Adds a bolded Black formatting directive in the Code Quality section — accurate and consistent with CI enforcement |
| AGENTS.md | Replaces a misleading 'does not block test runs' note with a clear pre-commit Black formatting directive |
| CONTRIBUTING.md | Adds a well-structured callout with Black guidance for AI agents and VS Code format-on-save setup |
| ci_cd/security_scans.sh | Entire security-scan runner script deleted without mention in PR description; confirmed not referenced by any active workflow |
| ci_cd/.grype.yaml | Grype vulnerability-scanner config deleted without explanation; not referenced by active workflows |
| .trivyignore | Root-level Trivy CVE allowlist with documented justifications deleted; not referenced by active workflows |
| .github/workflows/run_llm_translation_tests.py | File mode changed from executable (755) to non-executable (644); no functional impact since the workflow invokes it via 'python ...' |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Developer makes code changes] --> B{Run formatter?}
B -- No --> C[Push to PR]
C --> D[CI Black --check fails]
D --> E[Fix and re-push]
B -- Yes: poetry run black . --> F[Code is formatted]
F --> G[Push to PR]
G --> H[CI Black --check passes]
H --> I[PR ready to merge]
subgraph Guidance added in this PR
J[CLAUDE.md and AGENTS.md] -->|AI agents| B
K[CONTRIBUTING.md and VS Code format-on-save] -->|Human contributors| B
end
Reviews (2): Last reviewed commit: "chore: fixes" | Re-trigger Greptile
* [Docs] Enforce Black formatting in contributor docs Black formatting is now enforced in CI. Update CLAUDE.md, AGENTS.md, and CONTRIBUTING.md to instruct contributors and AI agents to run `poetry run black .` before committing, and add VS Code setup guidance. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * chore: fixes --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
Problem
Black formatting is enforced in CI but contributor docs didn't clearly communicate this requirement, leading to avoidable CI failures.
Fix
Updated
CLAUDE.md,AGENTS.md, andCONTRIBUTING.mdto explicitly instruct contributors and AI coding agents to runpoetry run black .before committing. Added VS Code setup guidance for human contributors.Testing
Documentation-only change. No code changes.
Type
📖 Documentation