chore: add pre-commit configuration and CI#12
Open
nearlyforget wants to merge 6 commits intoUniversal-Commerce-Protocol:mainfrom
Open
chore: add pre-commit configuration and CI#12nearlyforget wants to merge 6 commits intoUniversal-Commerce-Protocol:mainfrom
nearlyforget wants to merge 6 commits intoUniversal-Commerce-Protocol:mainfrom
Conversation
wry-ry
reviewed
Feb 21, 2026
| rev: v0.10.0 | ||
| hooks: | ||
| - id: shellcheck | ||
| - repo: https://github.com/codespell-project/codespell |
Contributor
There was a problem hiding this comment.
Do we want codespell here? We're using cspell on the main ucp repo.
Contributor
Author
There was a problem hiding this comment.
I switched to this for low maintenance so we don't have to manage
- additional custom files for each repo (e.g.custom keywords)
- update dictionary every time something new comes up.
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
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.
Description:
This PR establishes a robust linting and formatting pipeline for the Python SDK. By integrating pre-commit, we
automate the enforcement of code quality standards and security best practices.
Tools & Hooks Added:
Ruff: Highly efficient Python linter and formatter. Configured to automatically fix safe issues and ensure
consistent code style across the SDK's extensive model and schema definitions.
Prettier: Handles formatting for non-Python assets, including Markdown documentation, YAML workflows, and JSON
files.
ShellCheck: Ensures the reliability and portability of generate_models.sh.
codespell: Periodically checks the codebase for common typos in docstrings and comments.
Hygiene Hooks: Standardizes file endings and removes trailing whitespace to keep the diffs clean.
CI/CD Integration:
GitHub Actions (linter.yml): Automatically validates every push and pull request against these standards to
prevent the introduction of unformatted code.