fix: fix some broken links in CONTRIBUTING.md and PAID_BOUNTIES.md #1682
Conversation
Majority of the links should not be prepended with "blob/main" because
that inteferres with Github UI's root rendering which already prepends
the branch name so without this fix it would produce failing links like
https://github.com/quicksilver-zone/quicksilver/blob/main/blob/main/CODE_OF_CONDUCT.md
yet it should be
https://github.com/quicksilver-zone/quicksilver/blob/main/CODE_OF_CONDUCT.md
Updates quicksilver-zone#1645
odeke-em
requested review from
joe-bowman,
faddat,
minhngoc274 and
tuantran1702
as code owners
|
@odeke-em is attempting to deploy a commit to the quicksilver Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe main changes involve updating document links within Changes
Poem
Tip Early access features
Note:
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 as PR comments)
Additionally, you can add CodeRabbit Configration 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
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- CONTRIBUTING.md (1 hunks)
- PAID_BOUNTIES.md (1 hunks)
Files not reviewed due to errors (1)
- CONTRIBUTING.md (no review received)
Additional context used
LanguageTool
PAID_BOUNTIES.md
[style] ~15-~15: Consider a shorter alternative to avoid wordiness.
Context: ... issues](#security-issues) ## Preamble In order to ensure and stimulate equitable growth a...(IN_ORDER_TO_PREMIUM)
[typographical] ~17-~17: Usually, there’s no comma before “if”.
Context: ...sort of compensation for their hard work, if that hard work benefits the ecosystem. ...(IF_NO_COMMA)
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ...anges. The higher the number of quality eye-balls that we get on our code and products, t...(EN_COMPOUNDS_EYE_BALLS)
[grammar] ~44-~44: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...er lines of code: clearer directions to setup the chain or onboard users can even be ...(NOUN_VERB_CONFUSION)
[uncategorized] ~44-~44: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...can even be more impactful than a 2,000 line of code; reviewing a pull request and c...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[typographical] ~59-~59: Consider adding a comma after ‘ideally’ for more clarity.
Context: ...payments at the end of every month, and ideally we shall reach out directly to you to f...(RB_LY_COMMA)
[typographical] ~64-~64: Consider adding a comma here.
Context: ...X (formerly Twitter) ## Security issues Please report all security issues and vulnerab...(PLEASE_COMMA)
CONTRIBUTING.md
[style] ~8-~8: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ur appreciation, which we would also be very happy about: - Star the project - Tweet about...(EN_WEAK_ADJECTIVE)
[typographical] ~66-~66: Consider adding a comma after ‘Possibly’ for more clarity.
Context: ...er, depending on what seems relevant. - Possibly your input and the output - Can you rel...(RB_LY_COMMA)
[typographical] ~66-~66: It appears that a comma is missing.
Context: ...nt. - Possibly your input and the output - Can you reliably reproduce the issue? And c...(COMMA_BEFORE_QUESTION_WITH_MD)
[uncategorized] ~72-~72: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ... issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[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)
[style] ~85-~85: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ntil they are reproduced. - If the team is able to reproduce the issue, it will be marked ...(BE_ABLE_TO)
[style] ~90-~90: Consider using a different adverb to strengthen your wording.
Context: ...n for Quicksilver Protocol, **including completely new features and minor improvements to ...(COMPLETELY_ENTIRELY)
[typographical] ~107-~107: It appears that a comma is missing.
Context: ...ected to see instead** and why. At this point you can also tell which alternatives do...(DURING_THAT_TIME_COMMA)
Markdownlint
PAID_BOUNTIES.md
49-49: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
10-10: null
Link fragments should be valid(MD051, link-fragments)
CONTRIBUTING.md
85-85: null
Link fragments should be valid(MD051, link-fragments)
Additional comments not posted (3)
PAID_BOUNTIES.md (3)
25-25: LGTM!The link to
CONTRIBUTING.mdhas been correctly updated to remove the incorrect prefix.
26-26: LGTM!The link to
CODE_OF_CONDUCT.mdhas been correctly updated to remove the incorrect prefix.
28-28: LGTM!The link to
ROADMAP.mdhas been correctly updated to remove the incorrect prefix.
Majority of the links should not be prepended with "blob/main" because that inteferres with Github UI's root rendering which already prepends the branch name so without this fix it would produce failing links like
yet it should be
Updates #1645
Summary by CodeRabbit
CONTRIBUTING.mdandPAID_BOUNTIES.mdfor better navigation.