Skip to content

Conversation

@joamatab
Copy link
Contributor

@joamatab joamatab commented Dec 12, 2024

Summary by Sourcery

Documentation:

  • Update installation instructions for contributors to recommend using 'uv' for setting up the development environment.

@joamatab joamatab added the documentation Improvements or additions to documentation label Dec 12, 2024
@joamatab joamatab merged commit 1f1b351 into main Dec 12, 2024
3 checks passed
@sourcery-ai
Copy link

sourcery-ai bot commented Dec 12, 2024

Reviewer's Guide by Sourcery

This PR updates the README.md file to change the installation instructions for contributors, replacing the previous git-based workflow with UV (a new Python package installer and environment manager) installation instructions.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated contributor installation instructions to use UV package manager
  • Renamed 'Installation for developers' section to 'Installation for contributors'
  • Added UV installation commands for macOS/Linux and Windows
  • Replaced pip-based installation with UV commands
  • Removed git clone and pre-commit setup instructions
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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 the enhancement New feature or request label Dec 12, 2024
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.

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

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