Skip to content

Conversation

@hongquan
Copy link
Member

@hongquan hongquan commented Mar 28, 2025

Follow #318.
This PR adds a guide about how to run lint tools.
Because the command is long, I introduce a justfile to let run shorter command.

For why not use Makefile, there is an explanation.

How has this been tested?

Checklist

  • I have added tests to cover my changes.

Summary by Sourcery

Add a justfile to simplify developer tooling commands and improve documentation for running development tools

New Features:

  • Introduce a justfile with commands for common development tasks like formatting Django templates, building and serving docs, and building Docker images

Documentation:

  • Create a new documentation section in setup.rst to guide developers on running development tools

Chores:

  • Add justfile to provide more convenient command-line shortcuts for developers

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 28, 2025

Reviewer's Guide by Sourcery

This pull request introduces a justfile to simplify running development tools and adds documentation for setting up the development environment.

Flow diagram for using justfile

flowchart LR
    subgraph Using justfile
        A[Edit files] --> B{Run just command}
        B --> C{Execute command defined in justfile}
        C --> D[Result of the command]
    end
Loading

File-Level Changes

Change Details Files
Introduces a justfile to simplify running development tools with shorter commands.
  • Added a justfile with recipes for common development tasks.
  • Included recipes for formatting Django templates, building documentation, serving documentation, and building a Docker image for development.
justfile
Adds documentation for setting up the development environment.
  • Added a guide about how to run lint tools.
doc/developer/setup.rst

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@hongquan hongquan requested a review from norbusan March 28, 2025 04:30
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 @hongquan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • It might be worth mentioning just in the README or a contributing guide so developers know how to use it.
  • Consider adding a comment to the justfile explaining why each command is useful for development.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@hongquan hongquan merged commit 6aac51f into fossasia:development Mar 31, 2025
3 of 7 checks passed
@hongquan hongquan deleted the feature/doc-on-running-dev-tools branch April 11, 2025 03:33
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