docs: fix typos in prebuilt-binaries.md and release-guide.md #4030
Conversation
The word occured is incorrect; the correct spelling is occurred (with two "r"s).
The word relase is incorrect; the correct spelling is release.
0xbryer
requested review from
rootulp and
staheri14
and removed request for
a team
📝 WalkthroughWalkthroughThe pull request includes updates to two documentation files: Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/maintainers/prebuilt-binaries.md (1)
Line range hint
16-40: Consider documenting validation skip implicationsWhile the addition of
--skip=validateis well-documented, it would be helpful to briefly explain the potential risks or implications of skipping validation. This helps maintainers make informed decisions about when to use this option.Consider adding a note like:
1. [Optional] If you need to make any code changes to fix the issue that occurred when CI tried to generate and attach the prebuilt binaries, then you likely need to skip validation when running GoReleaser locally. To skip validation, modify the Makefile command like so: + Note: Skipping validation bypasses important checks. Only use this option when you're certain about the changes and understand the implications.🧰 Tools
🪛 LanguageTool
[style] ~16-~16: Consider using a different verb for a more formal wording.
Context: ...If you need to make any code changes to fix the issue that occurred when CI tried t...(FIX_RESOLVE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
docs/maintainers/prebuilt-binaries.md(1 hunks)docs/maintainers/release-guide.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/maintainers/release-guide.md
🧰 Additional context used
🪛 LanguageTool
docs/maintainers/prebuilt-binaries.md
[style] ~16-~16: Consider using a different verb for a more formal wording.
Context: ...If you need to make any code changes to fix the issue that occurred when CI tried t...
(FIX_RESOLVE)
🔇 Additional comments (2)
docs/maintainers/prebuilt-binaries.md (2)
16-16: LGTM: Spelling correction is accurate
The correction of "occurred" improves the documentation's accuracy and professionalism.
🧰 Tools
🪛 LanguageTool
[style] ~16-~16: Consider using a different verb for a more formal wording.
Context: ...If you need to make any code changes to fix the issue that occurred when CI tried t...
(FIX_RESOLVE)
Line range hint 41-46: Verify repository configuration and enhance documentation
The GitHub repository configuration looks correct, but let's verify and enhance the documentation.
Consider adding more context about these configuration values:
1. Modify `.goreleaser.yaml` so that you can upload assets to the main repository:
+ Note: These values must match the target repository where you want to upload the assets.
+ For contributors working on forks, you'll need to modify these values accordingly.
```diff
release:
github:
owner: celestiaorg
name: celestia-app
```✅ Verification successful
Repository configuration verified successfully
The GitHub repository configuration in the GoReleaser YAML matches the actual repository celestiaorg/celestia-app. The suggested documentation improvements would still be valuable for contributors working with forks.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify the repository details match the actual repository
gh repo view celestiaorg/celestia-app --json nameWithOwner -q .nameWithOwner
Length of output: 103
🧰 Tools
🪛 LanguageTool
[style] ~16-~16: Consider using a different verb for a more formal wording.
Context: ...If you need to make any code changes to fix the issue that occurred when CI tried t...
(FIX_RESOLVE)
rootulp
changed the title
|
rootulp please merge it. |
|
This needs two approvals. After the second approval, it will auto-merge. |
rootulp
requested review from
rach-id,
evan-forbes and
ninabarbakadze
and removed request for
liamsi and
staheri14
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2024 Celestia Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
Overview
Description:
This pull request addresses two spelling errors in the documentation files:
In
docs/maintainers/prebuilt-binaries.md:In
docs/maintainers/release-guide.md: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.