Skip to content

Maintenance of README, CHANGELOG, CONTRIBUTING, and scm system#168

Merged
beckermr merged 4 commits intomainfrom
update-docs-ruff-and-changelog
Feb 7, 2026
Merged

Maintenance of README, CHANGELOG, CONTRIBUTING, and scm system#168
beckermr merged 4 commits intomainfrom
update-docs-ruff-and-changelog

Conversation

@EiffL
Copy link
Member

@EiffL EiffL commented Feb 7, 2026

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:

  • Updated all references and instructions from Black to Ruff for code linting and formatting, including changes in CONTRIBUTING.md and the badge in README.md. Pre-commit hooks now run Ruff automatically, and contributors are instructed to use Ruff for checking and formatting code. [1] [2] [3]
  • Updated the development setup instructions to recommend using a virtual environment, installing development dependencies, and enabling pre-commit hooks. Corrected minor typos and improved clarity in the contributor workflow. [1] [2]

Changelog and project configuration:

  • Changed the CHANGELOG.md to direct users to GitHub Releases for the changelog, instead of maintaining a manual changelog in the file.
  • Fixed a typo in the [tool.setuptools_scm] section header in pyproject.toml for proper package version management.

EiffL and others added 2 commits February 7, 2026 16:02
- 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-hq
Copy link

codspeed-hq bot commented Feb 7, 2026

CodSpeed Performance Report

Merging this PR will not alter performance

Comparing update-docs-ruff-and-changelog (eddd75c) with main (16e5e32)1

Summary

✅ 31 untouched benchmarks

Footnotes

  1. No successful run was found on main (eddd75c) during the generation of this report, so 16e5e32 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@beckermr beckermr enabled auto-merge February 7, 2026 20:25
@beckermr beckermr merged commit fc125cf into main Feb 7, 2026
4 checks passed
@beckermr beckermr deleted the update-docs-ruff-and-changelog branch February 7, 2026 21:04
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