Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize justfile task names and parameters across projects #529

Merged
merged 1 commit into from
May 6, 2024

Conversation

reez
Copy link
Collaborator

@reez reez commented May 6, 2024

Description

Update task names in justfiles to improve clarity and consistency.

This was based on me using and thinking about it since just was introduced (loving just!).

Notes to reviewers

The main rule of thumb was VERB-NOUN (for example: test-offline) which was being used mostly but I just made sure we were using consistently across all files.

Changes ensure clear understanding and usage across multiple platforms (bdk-jvm, bdk-android, etc.).

If you'd like test-specific to be test-one I'm totally ok with that even though I slightly preferred test-specific per what I could intuit from other naming conventions. Or if you prefer any other naming conventions I'm open to it.

Changelog notice

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

New Features:

  • I've added tests for the new feature
  • I've added docs for the new feature

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

@reez reez self-assigned this May 6, 2024
@thunderbiscuit thunderbiscuit self-requested a review May 6, 2024 19:44
Copy link
Member

@thunderbiscuit thunderbiscuit left a comment

Choose a reason for hiding this comment

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

Love it! Also the alphabetical ordering cleans it up between files. ACK 44d6d3c.

Would you mind adding a new command while we're at it? A lot of other repos I've see use the following:

default:
  just --list

Which allows you to print the recipes for each directory you're in simply by calling just.

@reez
Copy link
Collaborator Author

reez commented May 6, 2024

Love it! Also the alphabetical ordering cleans it up between files. ACK 44d6d3c.

Would you mind adding a new command while we're at it? A lot of other repos I've see use the following:

default:
  just --list

Which allows you to print the recipes for each directory you're in simply by calling just.

awesome suggestion, I was actually wondering about that! You seem to be doing this a lot lately (answering questions I had bubbling around my head before I even asked them out loud), its great-

@reez reez marked this pull request as ready for review May 6, 2024 19:56
Copy link

coderabbitai bot commented May 6, 2024

Walkthrough

The updates across various justfile configurations in different Bitcoin Dev Kit (BDK) projects mainly involve renaming tasks, reordering task sequences, and adjusting task parameters. These changes are aimed at improving clarity, consistency, and the organization of build and test commands in the development environments of Android, JVM, Python, Swift, and Rust projects.

Changes

File Path Changes Summary
bdk-android/justfile, bdk-jvm/justfile Renamed tasks, reordered task definitions, adjusted task parameters.
bdk-ffi/justfile Reordered commands in check and test sections; included cargo fmt and cargo clippy in check, and cargo test --lib in test.
bdk-python/justfile, bdk-swift/justfile Task renaming and reorganization; specific tasks related to testing and building were renamed and reordered.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Member

@thunderbiscuit thunderbiscuit left a comment

Choose a reason for hiding this comment

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

ACK 7d95157.

@reez reez merged commit 7d95157 into bitcoindevkit:master May 6, 2024
25 checks passed
@reez reez deleted the just-update branch May 6, 2024 23:49
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.

2 participants