-
Notifications
You must be signed in to change notification settings - Fork 245
[TASK] Clarify black formatting guidance in CONTRIBUTING.md #706
Copy link
Copy link
Labels
acceptedDeprecated: use status/accepted. Kept for issue history; will be removed in milestone 0.10.0.Deprecated: use status/accepted. Kept for issue history; will be removed in milestone 0.10.0.area/ci-cdGitHub workflows, merge queue, gh-aw integrations, release pipeline.GitHub workflows, merge queue, gh-aw integrations, release pipeline.area/docs-sitedocs/src/content (Starlight), README, doc generation.docs/src/content (Starlight), README, doc generation.documentationDeprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0.Deprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0.priority/lowAccepted but not time-sensitiveAccepted but not time-sensitivestatus/acceptedDirection approved, safe to start work.Direction approved, safe to start work.status/triagedInitial agentic triage complete; pending maintainer ratification (silence = approval).Initial agentic triage complete; pending maintainer ratification (silence = approval).type/docsDocumentation change (prose, examples, generated reference).Documentation change (prose, examples, generated reference).
Milestone
Metadata
Metadata
Assignees
Labels
acceptedDeprecated: use status/accepted. Kept for issue history; will be removed in milestone 0.10.0.Deprecated: use status/accepted. Kept for issue history; will be removed in milestone 0.10.0.area/ci-cdGitHub workflows, merge queue, gh-aw integrations, release pipeline.GitHub workflows, merge queue, gh-aw integrations, release pipeline.area/docs-sitedocs/src/content (Starlight), README, doc generation.docs/src/content (Starlight), README, doc generation.documentationDeprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0.Deprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0.priority/lowAccepted but not time-sensitiveAccepted but not time-sensitivestatus/acceptedDirection approved, safe to start work.Direction approved, safe to start work.status/triagedInitial agentic triage complete; pending maintainer ratification (silence = approval).Initial agentic triage complete; pending maintainer ratification (silence = approval).type/docsDocumentation change (prose, examples, generated reference).Documentation change (prose, examples, generated reference).
Type
Fields
Give feedbackNo fields configured for Task.
Projects
StatusShow more project fields
Done
Problem
The CONTRIBUTING.md guide references
blackas a formatting tool, butblackis not enforced in CI. When contributors follow the guide and runuv run black ., they get 308 files reformatted -- leading to confusion about whether to include formatting changes in their PRs.This was flagged by @jacobokeeffe-ow in #688:
Proposed Resolution
Pick one of:
blackfrom the contributing guide -- if we don't enforce it, don't recommend it. Contributors should follow the existing code style in each file.blackto CI -- enforce it and do a one-time repo-wide reformat. This is a larger change but establishes a clear standard.blackis not enforced in CI.Impact
Contributor confusion and unnecessary formatting noise in PRs. Low severity but affects contributor experience.