forked from mempool/mempool
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
0 / 10 of 1 issue completedOpen
0 / 10 of 1 issue completed
Copy link
Labels
good first issueGood for newcomersGood for newcomers
Description
Reviewer's Guide
Add new CircleCI pipeline to enforce code formatting and run Rust tests via cargo in a cached Docker environment.
Flow diagram for build-and-test job steps in CircleCI
flowchart TD
Checkout["Checkout source code"] --> RestoreCache["Restore Cargo cache"]
RestoreCache --> FormatCheck1["Check formatting (cargo fmt -- --check)"]
FormatCheck1 --> TestRun1["Run tests (cargo test)"]
TestRun1 --> SaveCache["Save Cargo cache"]
SaveCache --> FormatCheck2["Check formatting (cargo fmt -- --check)"]
FormatCheck2 --> TestRun2["Run tests (cargo test)"]
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Introduce CircleCI configuration for Rust CI pipeline |
|
.circleci/cargo.yml |
Possibly linked issues
- Create cargo.yml #24: The PR creates the cargo.yml file and implements the build-and-test job as detailed in the issue, including formatting, testing, and caching.
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon 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 issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment@sourcery-ai summaryon the pull request to
(re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull
request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon 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 dismisson 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 reviewto 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
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
Originally posted by @sourcery-ai[bot] in #31 (comment)
Sub-issues
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomers
Projects
Status
Backlog
Status
Todo