celestiaorg / celestia-app

Celestia consensus node
https://celestiaorg.github.io/celestia-app/
Apache License 2.0
346 stars 293 forks source link

docs: fix typos in prebuilt-binaries.md and release-guide.md #4030

Closed 0xbryer closed 1 week ago

0xbryer commented 1 week ago

Overview

Description: This pull request addresses two spelling errors in the documentation files:

  1. In docs/maintainers/prebuilt-binaries.md:

    • The word occured is corrected to occurred (with two "r"s).
  2. In docs/maintainers/release-guide.md:

    • The word relase is corrected to release (with an extra "e").

Importance: These spelling corrections ensure that the documentation is accurate and professional. Correct spelling is important in maintaining clarity and trust in the documentation, especially for new contributors and users. It also improves searchability, as users may encounter issues when searching for these terms with the incorrect spelling.

coderabbitai[bot] commented 1 week ago
📝 Walkthrough ## Walkthrough The pull request includes updates to two documentation files: `prebuilt-binaries.md` and `release-guide.md`. The changes correct typographical errors and enhance instructions related to running GoReleaser and creating release candidates. Specifically, the command for running GoReleaser has been modified to include the `--skip=validate` option, and additional details regarding the GitHub owner and repository name have been specified. Minor textual corrections have also been made in the release guide to improve accuracy. ## Changes | File Path | Change Summary | |---------------------------------------------|-----------------------------------------------------------------------------------------------------| | docs/maintainers/prebuilt-binaries.md | Corrected "that occured" to "that occurred"; updated GoReleaser command to include `--skip=validate`; specified GitHub owner and repository name. | | docs/maintainers/release-guide.md | Corrected "Set as a pre-relase" to "Set as a pre-release"; minor textual clarifications. | ## Possibly related PRs - #3675: This PR addresses typographical errors in documentation, similar to the corrections made in the main PR regarding the phrase "that occured" to "that occurred." - #3681: This PR also focuses on correcting grammatical issues in documentation, aligning with the main PR's objective of improving documentation clarity. - #3989: This PR updates the `release-guide.md`, which is also a documentation change, enhancing clarity and completeness, similar to the updates made in the main PR. - #4002: This PR improves the clarity of installation instructions in the `README.md`, which is related to enhancing user guidance, akin to the changes in the main PR. ## Suggested labels `external` ## Suggested reviewers - liamsi - rootulp - cmwaters

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **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 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. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
0xbryer commented 1 week ago

rootulp please merge it.

rootulp commented 1 week ago

This needs two approvals. After the second approval, it will auto-merge.

gitpoap-bot[bot] commented 1 week ago

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.