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

Use Rust proto crate name as dydx-proto #2543

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

v0-e
Copy link
Contributor

@v0-e v0-e commented Oct 28, 2024

Changelist

Changes Rust protocol buffers crate name to dydx-proto, removing the -rust, since the crate name is available and using -rust is redundant in Rust code.

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • The project has been rebranded from dydx-proto-rust to dydx-proto, simplifying the package name for better clarity.
  • Documentation

    • Updated README to reflect the new dependency name, enhancing consistency across project documentation.
  • Configuration

    • Adjusted license clarification in configuration files to align with the new package name.

@v0-e v0-e requested a review from a team as a code owner October 28, 2024 08:57
Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

Walkthrough

The changes in this pull request involve renaming the Rust crate from "dydx-proto-rust" to "dydx-proto" across several files. The modifications are primarily found in Cargo.toml, README.md, and deny.toml, where the package name and dependency references have been updated to reflect this new name. No other attributes or settings in these files have been altered.

Changes

File Change Summary
v4-proto-rs/Cargo.toml Package name updated from "dydx-proto-rust" to "dydx-proto"
v4-proto-rs/README.md Dependency name updated from dydx-proto-rust to dydx-proto
v4-proto-rs/deny.toml License clarification updated from "dydx-proto-rust" to "dydx-proto"

Possibly related PRs

Suggested reviewers

  • jiajames

Poem

In a meadow where the bunnies play,
A name was changed, hip-hip-hooray!
From "rust" to "proto," a leap so spry,
Hopping along, we reach for the sky!
With every change, we dance and cheer,
For a brighter name, we hold so dear! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b5a95d4 and 017c3f0.

📒 Files selected for processing (3)
  • v4-proto-rs/Cargo.toml (1 hunks)
  • v4-proto-rs/README.md (1 hunks)
  • v4-proto-rs/deny.toml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • v4-proto-rs/Cargo.toml
🔇 Additional comments (3)
v4-proto-rs/deny.toml (1)

34-34: LGTM! Crate name update aligns with PR objectives.

The change correctly updates the crate name in the license clarification section while maintaining the same license expression and file hash.

Let's verify consistency with Cargo.toml:

✅ Verification successful

Crate name update is consistent across files

The verification confirms:

  • Cargo.toml correctly uses the new name dydx-proto
  • No remaining references to the old name dydx-proto-rust were found
  • The change in deny.toml is properly aligned with the package name
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the crate name in Cargo.toml matches the one in deny.toml

# Test: Search for package name in Cargo.toml. Expect: name = "dydx-proto"
rg -A 1 'name\s*=' v4-proto-rs/Cargo.toml

# Test: Search for any remaining references to old crate name. Expect: No matches
rg 'dydx-proto-rust' v4-proto-rs/

Length of output: 115

v4-proto-rs/README.md (2)

9-9: LGTM! Dependency name updated correctly.

The dependency declaration has been updated from dydx-proto-rust to dydx-proto as intended.


Line range hint 1-100: Verify no remaining references to old crate name.

Let's verify that no other mentions of the old crate name dydx-proto-rust remain in the README.

✅ Verification successful

No references to old crate name found

The search results confirm that only the new crate name dydx-proto is used in the README.md and Cargo.toml files. There are no remaining references to the old crate name dydx-proto-rust.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining references to the old crate name
rg "dydx-proto-rust" "v4-proto-rs/README.md"

# Also check other potential documentation files that might need updates
fd -t f "README|\.md$" -X rg "dydx-proto-rust"

Length of output: 89


Script:

#!/bin/bash
# Let's verify by searching for both the old and new crate names to ensure we have context
rg -i "dydx.?proto" "v4-proto-rs/README.md"

# Also check Cargo.toml for the crate name
cat "v4-proto-rs/Cargo.toml"

# Check other potential documentation files
fd -t f "README|\.md$" -X rg -i "dydx.?proto"

Length of output: 8817


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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@jiajames jiajames merged commit 61c2d54 into dydxprotocol:main Oct 28, 2024
2 checks passed
adamfraser pushed a commit that referenced this pull request Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants