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

docs: Rectify typographical inaccuracies #3675

Merged
merged 6 commits into from
Jul 13, 2024
Merged

Conversation

nnsW3
Copy link
Contributor

@nnsW3 nnsW3 commented Jul 10, 2024

This PR addresses several typographical errors across various files in the project. The changes improve readability and maintain the professional standard of the documentation and code comments.

Justification
Typographical errors, while minor, can detract from the overall quality of the project. Correcting these errors ensures clarity and professionalism, making the project more accessible and understandable for current and future contributors.

Hope it helps.

@nnsW3 nnsW3 requested review from liamsi and a team as code owners July 10, 2024 18:53
@nnsW3 nnsW3 requested review from rootulp and rach-id and removed request for a team July 10, 2024 18:53
Copy link
Contributor

coderabbitai bot commented Jul 10, 2024

Walkthrough

Walkthrough

The changes involve minor corrections and clarifications in various architecture decision records (ADRs). These updates include improving comments related to voting behavior and conditions, fixing grammatical errors, and enhancing the functionality description for network upgrades by introducing MsgVersionChange for signaling upgrades.

Changes

File Path Change Summary
docs/architecture/adr-001-abci++-adoption.md Updated comment to clarify voting behavior when the application invalidates a block.
docs/architecture/adr-002-qgb-valset.md Corrected grammatical errors to clarify the functionality of QGB as a one-way bridge.
docs/architecture/adr-006-non-interactive-defaults.md Fixed a typographical error in a comment related to comparison of totalSharesUsed.
docs/architecture/adr-018-network-upgrades.md Enhanced upgrade process to support state migrations, handle schedule changes, and tolerate faults.

Sequence Diagram(s)

Silently ignored as the changes are primarily textual and clarificatory.


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. 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.
    • @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 as 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.

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.

@celestia-bot celestia-bot requested a review from a team July 10, 2024 18:54
Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>
@celestia-bot celestia-bot requested review from a team and ninabarbakadze and removed request for a team July 11, 2024 09:55
@celestia-bot celestia-bot requested review from a team, cmwaters and staheri14 and removed request for a team July 13, 2024 09:34
@rootulp rootulp merged commit 6116a2e into celestiaorg:main Jul 13, 2024
33 of 34 checks passed
Copy link

gitpoap-bot bot commented Jul 13, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 Celestia Contributor:

GitPOAP: 2024 Celestia Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants