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

fix/fix_readme_installation #223

Merged
merged 1 commit into from
May 22, 2024
Merged

fix/fix_readme_installation #223

merged 1 commit into from
May 22, 2024

Conversation

aarmoa
Copy link
Collaborator

@aarmoa aarmoa commented May 22, 2024

  • Fixed instructions on how to prepare to use the SDK after cloning the repo

Fixes #222

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to use go mod download instead of go install ./... for installing dependencies in the sdk-go repository.

Copy link

coderabbitai bot commented May 22, 2024

Walkthrough

The primary change involves updating the installation process for Go dependencies in the sdk-go repository. Instead of using go install ./..., the new approach utilizes go mod download to manage and install dependencies.

Changes

File Change Summary
README.md Updated instructions to use go mod download instead of go install ./... for installing dependencies.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Error when installing Go libraries (#222)

In the code's realm, dependencies align,
With go mod download, all works fine.
No more errors, no more plight,
For M1 Pro, it’s a smoother flight.
🐇✨


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>.
    • 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 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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (3)
README.md (3)

Line range hint 34-34: Consider adding a note that the make copy-exchange-client command requires the injective-indexer repository to be cloned as mentioned.


Line range hint 44-47: Consider using a pull request workflow instead of pushing directly to master for better collaboration and review.


Line range hint 67-67: Remove the colon after "under" to correct the grammatical structure.

- Originally released by Injective Labs Inc. under:
+ Originally released by Injective Labs Inc. under
Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 8a251c5 and de43c30.
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (2)
README.md (2)

Near line 63: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...` --- ## License Copyright © 2020 - 2022 Injective Labs Inc. (https://inject...


Near line 67: Do not use a colon (:) before a series that is introduced by a preposition (‘under’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...ginally released by Injective Labs Inc. under:
Apache License
Version 2....

Markdownlint (13)
README.md (13)

12: null
Dollar signs used before commands without showing output


13: null
Dollar signs used before commands without showing output


14: null
Dollar signs used before commands without showing output


34: null
Dollar signs used before commands without showing output


44: null
Dollar signs used before commands without showing output


45: null
Dollar signs used before commands without showing output


46: null
Dollar signs used before commands without showing output


47: null
Dollar signs used before commands without showing output


17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


18: null
Fenced code blocks should be surrounded by blank lines


63: null
Bare URL used


70: null
Bare URL used


65: null
Images should have alternate text (alt text)

Additional comments not posted (1)
README.md (1)

14-14: Change approved: Switch from go install ./... to go mod download should help resolve dependency issues on specific architectures.

@aarmoa aarmoa merged commit 7294750 into master May 22, 2024
4 checks passed
@aarmoa aarmoa deleted the fix/fix_readme_installation branch May 22, 2024 12:44
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.

Error when install the go libraries
1 participant