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 : broken twitter link in README.md #1018

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

rishi95122
Copy link

@rishi95122 rishi95122 commented May 16, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the Twitter link in the README from @Injective_ to @injective for accurate social media reference.

Copy link

coderabbitai bot commented May 16, 2024

Walkthrough

The README.md file has been updated to reflect a change in the Twitter link for the project. The old link @Injective_ has been updated to the new handle @injective, ensuring users are directed to the correct Twitter profile.

Changes

File Change Summary
README.md Updated Twitter link from https://twitter.com/Injective_ to https://twitter.com/injective

Poem

In the realm of code so bright,
A link was changed to guide the light.
From Injective_ it took its flight,
To injective, shining right.
Follow now, with just delight,
The path is clear, the future's bright.
🐇✨


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

Out of diff range and nitpick comments (15)
README.md (15)

Line range hint 37-37: Rephrase for better readability.

- You can always boot the dex locally on your own laptop without having to set up a relayer. You can use the `public` network in your `VITE_NETWORK` `.env` configuration variable and run the `yarn run dev` command. You can find all of the available networks (i.e - predefined set of endpoints) here.
+ Boot the dex locally on your own laptop without setting up a relayer. Use the `public` network in your `VITE_NETWORK` `.env` configuration variable and run the `yarn run dev` command. Find all available networks (i.e - predefined set of endpoints) here.

Line range hint 41-41: Add a comma for clarity.

- Deployment to AWS is done to a S3 bucket which is served through Cloudfront to the end user.
+ Deployment to AWS is done to a S3 bucket, which is served through Cloudfront to the end user.

Line range hint 48-48: Remove the comma and add an article.

- We've migrated the `injective-helix` repo to Nuxt3 in January, 2023. To make the migration on your fork, there are couple of simple steps that you have to do:
+ We've migrated the `injective-helix` repo to Nuxt3 in January 2023. To make the migration on your fork, there are a couple of simple steps that you have to do:

Line range hint 53-53: Correct the spelling of "leftovers".

- Clean up left overs from the previous deployments `yarn clean-up && rm -rf dist`
+ Clean up leftovers from the previous deployments `yarn clean-up && rm -rf dist`

Line range hint 54-54: Remove "of" to be more concise.

- Update your `.env` file and add `VITE_` prefix to all of the `.env` variables,
+ Update your `.env` file and add `VITE_` prefix to all the `.env` variables,

Line range hint 46-46: Remove trailing spaces.

- 
+ 

Line range hint 51-51: Remove trailing spaces.

- 
+ 

Line range hint 55-55: Remove trailing spaces.

- 
+ 

Line range hint 45-45: Remove extra blank lines.

- 
+ 

Line range hint 21-23: Remove dollar signs for consistency.

- $ git clone [email protected]:InjectiveLabs/injective-dex.git
- $ cd injective-dex
- $ yarn
+ git clone [email protected]:InjectiveLabs/injective-dex.git
+ cd injective-dex
+ yarn

Line range hint 30-30: Remove dollar signs for consistency.

- $ yarn dev
+ yarn dev

Line range hint 75-75: Format URL as a link.

- http://www.apache.org/licenses/
+ [Apache License](http://www.apache.org/licenses/)

Line range hint 82-82: Format URL as a link.

- https://iili.io/mNneZN.md.png
+ ![Injective Labs](https://iili.io/mNneZN.md.png)

Line range hint 3-3: Replace emphasis with a heading.

- _Helix | The Premier Decentralized Spot and Derivatives Exchange_
+ ## Helix | The Premier Decentralized Spot and Derivatives Exchange

Line range hint 77-77: Add alternate text for accessibility.

- <img src="https://iili.io/mNneZN.md.png" style="width: 300px; max-width: 100%; height: auto" />
+ <img src="https://iili.io/mNneZN.md.png" alt="Injective Labs" style="width: 300px; max-width: 100%; height: auto" />
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 352cd95 and c0b7209.
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (12)
README.md (12)

Near line 37: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ble and run the yarn run dev command. You can find all of the available networks ...


Near line 37: Consider removing “of” to be more concise
Context: ...he yarn run dev command. You can find all of the available networks (i.e - predefined se...


Near line 41: Possible missing comma found.
Context: ...file. Deployment to AWS is done to a S3 bucket which is served through Cloudfront to t...


Near line 48: When specifying a month and year, the comma is unnecessary.
Context: ... the injective-helix repo to Nuxt3 in January, 2023. To make the migration on your fork, th...


Near line 48: It seems that an article is missing. Did you mean “a couple of”?
Context: ...e the migration on your fork, there are couple of simple steps that you have to do: 1. P...


Near line 53: The noun “leftovers” is spelled as one word.
Context: ...dependencies yarn install 4. Clean up left overs from the previous deployments `yarn cle...


Near line 54: Consider removing “of” to be more concise
Context: ...r .env file and add VITE_ prefix to all of the .env variables, 6. Run the dex `yarn ...


Near line 63: This phrase is duplicated. You should probably use “Website at” only once.
Context: ...o us at one of the following places! - Website at injective.com - Website at <a href="https://injectivelabs.org" tar...


Near line 65: This phrase is duplicated. You should probably use “Twitter at” only once.
Context: ...rget="_blank">injectivelabs.org - Twitter at @Injective - Twitter at <a href="https://twitter.com/InjectiveL...


Near line 67: This phrase is duplicated. You should probably use “at Telegram” only once.
Context: ..."_blank">@InjectiveLabs - Discord at Injective Discord - Telegram at Injective Telegram - Telegram at <a href="https://t.me/helixapp" targ...


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


Near line 79: 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....

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

65-65: Twitter link updated correctly.

@@ -62,7 +62,7 @@ Reach out to us at one of the following places!

- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
Copy link

Choose a reason for hiding this comment

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

Remove the duplication of "Website at".

- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
- Website at <a href="https://injectivelabs.org" target="_blank">`injectivelabs.org`</a>
+ Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
+ <a href="https://injectivelabs.org" target="_blank">`injectivelabs.org`</a>

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
<a href="https://injectivelabs.org" target="_blank">`injectivelabs.org`</a>

@@ -62,7 +62,7 @@ Reach out to us at one of the following places!

- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
- Website at <a href="https://injectivelabs.org" target="_blank">`injectivelabs.org`</a>
- Twitter at <a href="https://twitter.com/Injective_" target="_blank">`@Injective`</a>
- Twitter at <a href="https://twitter.com/injective" target="_blank">`@Injective`</a>
Copy link

Choose a reason for hiding this comment

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

Remove the duplication of "Twitter at".

- Twitter at <a href="https://twitter.com/injective" target="_blank">`@Injective`</a>
- Twitter at <a href="https://twitter.com/InjectiveLabs" target="_blank">`@InjectiveLabs`</a>
+ Twitter at <a href="https://twitter.com/injective" target="_blank">`@Injective`</a>
+ <a href="https://twitter.com/InjectiveLabs" target="_blank">`@InjectiveLabs`</a>

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- Twitter at <a href="https://twitter.com/injective" target="_blank">`@Injective`</a>
Twitter at <a href="https://twitter.com/injective" target="_blank">`@Injective`</a>
<a href="https://twitter.com/InjectiveLabs" target="_blank">`@InjectiveLabs`</a>

@@ -62,7 +62,7 @@ Reach out to us at one of the following places!

- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
- Website at <a href="https://injectivelabs.org" target="_blank">`injectivelabs.org`</a>
- Twitter at <a href="https://twitter.com/Injective_" target="_blank">`@Injective`</a>
- Twitter at <a href="https://twitter.com/injective" target="_blank">`@Injective`</a>
- Twitter at <a href="https://twitter.com/InjectiveLabs" target="_blank">`@InjectiveLabs`</a>
- Discord at <a href="https://discord.com/invite/NK4qdbv" target="_blank">`Injective Discord`</a>
Copy link

Choose a reason for hiding this comment

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

Remove the duplication of "Telegram at".

- Telegram at <a href="https://t.me/joininjective" target="_blank">`Injective Telegram`</a>
- Telegram at <a href="https://t.me/helixapp" target="_blank">`Helix Telegram`</a>
+ Telegram at <a href="https://t.me/joininjective" target="_blank">`Injective Telegram`</a>
+ <a href="https://t.me/helixapp" target="_blank">`Helix Telegram`</a>

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- Discord at <a href="https://discord.com/invite/NK4qdbv" target="_blank">`Injective Discord`</a>
Telegram at <a href="https://t.me/joininjective" target="_blank">`Injective Telegram`</a>
<a href="https://t.me/helixapp" target="_blank">`Helix Telegram`</a>

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