Maintenance of README, CHANGELOG, CONTRIBUTING, and scm system#168
Merged
Maintenance of README, CHANGELOG, CONTRIBUTING, and scm system#168
Conversation
- README: replace Black badge with Ruff badge - CONTRIBUTING: replace all Black references with Ruff, add venv setup, fix typos (donwload, -set-upstream, stray backtick), remove CHANGELOG.md update step from PR checklist - CHANGELOG: point to GitHub Releases instead of inline changelog Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
CodSpeed Performance ReportMerging this PR will not alter performanceComparing Summary
Footnotes |
beckermr
reviewed
Feb 7, 2026
beckermr
approved these changes
Feb 7, 2026
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.
This pull request updates the documentation and configuration to improve the development workflow and clarify project practices. The most significant changes include switching from Black to Ruff for code linting and formatting, updating setup instructions for contributors, and revising the changelog process.
Development workflow and code style:
CONTRIBUTING.mdand the badge inREADME.md. Pre-commit hooks now run Ruff automatically, and contributors are instructed to use Ruff for checking and formatting code. [1] [2] [3]Changelog and project configuration:
CHANGELOG.mdto direct users to GitHub Releases for the changelog, instead of maintaining a manual changelog in the file.[tool.setuptools_scm]section header inpyproject.tomlfor proper package version management.