Skip to content

add install, pre-commit, and release instructions to README#502

Merged
joamatab merged 3 commits intomainfrom
add-readme-instructions
Apr 11, 2026
Merged

add install, pre-commit, and release instructions to README#502
joamatab merged 3 commits intomainfrom
add-readme-instructions

Conversation

@joamatab
Copy link
Copy Markdown
Contributor

@joamatab joamatab commented Mar 13, 2026

Summary

  • Add installation, pre-commit, and release instructions to README

🤖 Generated with Claude Code

Summary by Sourcery

Document pre-commit usage and release workflow in the project README.

Documentation:

  • Add README section describing how to run pre-commit checks via make.
  • Add README section outlining the automated GitHub Actions release process and steps to publish a release.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Mar 13, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documents how to run pre-commit checks and explains the automated GitHub Actions-based release process, including the steps a maintainer should follow to publish a tagged release.

File-Level Changes

Change Details Files
Document the pre-commit workflow so contributors know how to run local checks.
  • Add a new README section titled Pre-commit.
  • Specify make pre-commit as the command to run pre-commit checks locally.
README.md
Document the automated release process powered by GitHub Actions.
  • Add a new README section titled Release.
  • Explain that releases are automated via GitHub Actions and that merging to main drives release drafting.
  • Describe the three-step process: merge to main, let the release drafter create/update a draft release, then publish the draft with a semantic version tag to trigger wheel build and upload.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 13, 2026
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

joamatab and others added 2 commits March 13, 2026 14:18
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@ThomasPluck ThomasPluck left a comment

Choose a reason for hiding this comment

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

Fix pre-commit, but this is only nice-to-have

@joamatab joamatab merged commit ba888cc into main Apr 11, 2026
6 of 7 checks passed
@joamatab joamatab deleted the add-readme-instructions branch April 11, 2026 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants