Repository navigation
Conversation
Ruff is the project's formatter and linter of record: CI (lint.yml, linting-full.yml) only invokes ruff, and Makefile's LINTERS list (the `make lint` full suite) never included black. Update prose across CONTRIBUTING.md, DEVELOPING.md, SECURITY.md, AGENTS.md, docs/, llms/, and the GitHub issue/PR templates so recommended commands and stated formatting policy reference ruff instead of black. The Makefile's legacy `black`/`black-check` targets, FILE_AWARE_LINTERS entry, and pyproject.toml's [tool.black] section still exist and are functional (confirmed via BLACK_VERSION, uvx invocation, and mcp-servers sub-templates that still depend on black), so this change intentionally leaves that tooling untouched -- removing a still-working target is a build/dependency change, not a documentation fix. isort's `profile = "black"` setting is also left as-is since it names a real, active isort profile, not a black-the-formatter reference. Fixes IBM#5248 Signed-off-by: Vaibhav Naik <naikvaib@amazon.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #5248.
The Makefile's
black/black-checktargets andpyproject.toml's[tool.black]are still real and functional (invoked via uvx), so I left those untouched — removing them would be a dependency/tooling change, not a docs fix. However, CI (lint.yml,linting-full.yml) andmake lint'sLINTERSlist only enforce ruff; black was never part of the enforced pipeline. So this PR updates the doc/policy text that inaccurately states black as the formatting standard/workflow across CONTRIBUTING.md, DEVELOPING.md, SECURITY.md, AGENTS.md, a few docs/ pages, PR/issue templates, and llms/ reference docs — 14 files, doc prose only.Left untouched (intentionally): Makefile black targets, pyproject.toml [tool.black], isort's profile="black" setting (unrelated to the formatter), and llms/mcp-server-python.md (documents a template that genuinely still uses black).
Ran markdownlint-cli2 on all touched files — no new lint errors introduced.