Skip to content

Conversation

@patrickelectric
Copy link
Member

@patrickelectric patrickelectric commented Jan 17, 2026

Summary by Sourcery

Documentation:

  • Clarify documentation so developers run the provided hook scripts at the end of a task instead of only at commit time.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 17, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Update the agents documentation to instruct running pre-push hooks at the end of a task rather than only at commit time, aligning guidance with task-based workflows.

Flow diagram for updated hook usage at end of task

flowchart TD
  Start[Start work on task]
  Plan[Plan implementation]
  Code[Implement changes]
  Test[Run local tests]
  HooksFix[Run .hooks/pre-push --fix]
  HooksCheck[Run .hooks/pre-push]
  Push[Push branch]
  PR[Open pull request]
  Done[Task finished]

  Start --> Plan --> Code --> Test --> HooksFix --> HooksCheck --> Push --> PR --> Done
Loading

File-Level Changes

Change Details Files
Adjust developer workflow guidance from commit-based to task-based for running pre-push hooks.
  • Replace wording that suggests hooks must be run before each commit with wording that they must be run before finishing a task
  • Keep the documented commands for running the pre-push hook (with and without --fix) unchanged
AGENTS.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

Copy link

@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.

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.

1 participant