Fix: broken links detected in issue #1716 #1717
Conversation
juliogarciape
requested review from
joe-bowman,
faddat and
minhngoc274
as code owners
|
@juliogarciape is attempting to deploy a commit to the quicksilver Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe changes involve updates to documentation files, specifically Changes
Possibly related PRs
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
CodeRabbit Configuration File (
|
![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)
CONTRIBUTING.md (1)
76-76: LGTM, with a minor suggestion!The change from a relative path to an absolute URL for the link to open a new issue is correct and consistent with the previous update.
Regarding the writing style, consider rephrasing the sentence to use a more professional alternative to "talk about", such as:
- ...r it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) + ...r it is a bug or not, we ask you not to discuss a bug yet and not to label the issue.)This will help elevate the writing to a more professional tone.
Tools
LanguageTool
[style] ~76-~76: The phrase ‘talk about’ can be informal. To elevate your writing, consider using a more professional alternative.
Context: ...r it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) ...(TALK_ABOUT_DISCUSS)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- CONTRIBUTING.md (4 hunks)
- README.md (1 hunks)
- x/mint/README.md (1 hunks)
Files skipped from review due to trivial changes (2)
- README.md
- x/mint/README.md
Additional context used
LanguageTool
CONTRIBUTING.md
[style] ~76-~76: The phrase ‘talk about’ can be informal. To elevate your writing, consider using a more professional alternative.
Context: ...r it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) ...(TALK_ABOUT_DISCUSS)
Additional comments not posted (3)
CONTRIBUTING.md (3)
39-39: LGTM!The change from a relative path to an absolute URL for the link to open a new issue is correct and ensures that the link will work from any location.
61-61: LGTM!The change from a relative path to an absolute URL with query parameters for the link to search existing bug reports is correct. The query parameters ensure that only relevant bug issues are shown, which enhances the user experience.
97-97: LGTM!The changes to the link for searching existing enhancement suggestions and the link text clarifying how enhancement suggestions are tracked are correct and improve the documentation.
Also applies to: 103-103
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1717 +/- ##
=======================================
Coverage 63.41% 63.41%
=======================================
Files 194 194
Lines 13436 13436
=======================================
Hits 8521 8521
Misses 4097 4097
Partials 818 818
Flags with carried forward coverage won't be shown. Click here to find out more. |
1. Summary
Fixes #1716
2.Type of change
3. Implementation details
The main
README.mdfile in the badges section had a link to the GolangCI website, however the GolangCI web platform stopped working since 2020 causing this to get a 404 error, however GolangCI moved to Github Actions and this repo uses it, so a Github Actions badge was added and a new link was set in the repo that references the current workflow in GHAThe
CONTRIBUTING.mdlinks are broken because they send you to a relative path to open anissueso the link was changed to an absolute path in order to correctly redirect to theissues/new/chooseoption to choose first the template to be used when opening anew issueThe link to the
README.mdfile in thex/mint/README.mddirectory is broken due to a syntax error in Markdown so the syntax was simply correctedSummary by CodeRabbit
CONTRIBUTING.mdfor easier access to GitHub issue tracking.CONTRIBUTING.mdregarding submitting enhancement suggestions.README.mdfor real-time project status.x/mint/README.mdfor improved documentation usability.