Skip to content

Conversation

jonpspri
Copy link
Contributor

Summary

This PR updates documentation and configuration to accurately reflect the project's use of Black for formatting instead of ruff format.

Changes

  • Best practices documentation: Updated linting section to reference black and isort instead of ruff format
  • Documentation fixes:
    • Fixed typo: 'santitization' → 'sanitization'
    • Updated container base image reference from UBI9 to UBI10 (current: ubi10-minimal:10.0-1755721767)
  • Makefile: Aligned linting targets with Black formatter usage

Context

The project uses Black as the code formatter (configured in pyproject.toml with line-length=200), not ruff format. This PR ensures documentation matches actual tooling.

Testing

  • Verified changes align with actual Containerfile (line 51)
  • Confirmed Black configuration in pyproject.toml
  • Reviewed CLAUDE.md which documents: make autoflake isort black pre-commit

@Copilot Copilot AI review requested due to automatic review settings October 20, 2025 09:32
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the project's documentation and Makefile to accurately reflect the use of Black as the code formatter instead of ruff format, along with correcting a spelling error and updating the base container image reference.

  • Corrected documentation to reference black and isort as formatting tools rather than ruff format
  • Updated container base image reference from UBI9 to UBI10 in documentation
  • Modified Makefile to disable ruff formatting and clarify current tool usage

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/docs/best-practices/mcp-best-practices.md Fixed spelling error, updated linting documentation to reference black/isort, and updated UBI container reference
Makefile Updated ruff target to disable formatting and added clarifying comments

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@jonpspri
Copy link
Contributor Author

@crivetimihai Could you please re-trigger these tests? I'm suspecting the upload failed in the Great AWS Outage of October 2025 :)

…s ruff format (with doc fixes)

- Update best practices doc to reference black and isort instead of ruff format
- Fix typo: 'santitization' -> 'sanitization'
- Update container base image reference from UBI9 to UBI10
- Align Makefile linting targets with black formatter usage

Signed-off-by: Jonathan Springer <[email protected]>
@crivetimihai crivetimihai force-pushed the chore/black-for-format branch from 7110b15 to 0f019c6 Compare October 21, 2025 00:04
@crivetimihai crivetimihai merged commit 0b0c0a7 into IBM:main Oct 21, 2025
40 of 41 checks passed
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.

2 participants