fix: updated broken links for fork/pr #1545
Conversation
WalkthroughThe changes in this pull request involve modifications to the Changes
Assessment against linked issues
Poem
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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
CONTRIBUTING.md (2)
24-25: Excellent improvement to the documentation!The addition of the direct link to GitHub's documentation on forking a repository is a great enhancement. This change addresses the issue of the non-functional "fork" link and provides clear guidance for contributors. It improves the usability of the contributing guide and makes it easier for new contributors to get started.
Line range hint
1-46: Overall improvement to the contributing guideThe changes made to the
CONTRIBUTING.mdfile significantly enhance its usability and clarity. By adding direct links to GitHub's documentation for forking a repository and creating pull requests (once the URL is corrected), the guide becomes more user-friendly and informative for potential contributors.These improvements align well with the PR objectives and address the issues of non-functional links mentioned in the PR summary. The overall structure and content of the document remain intact, maintaining its coherence while enhancing specific areas.
Once the URL for the pull request documentation is corrected, these changes will greatly benefit new contributors by providing them with easy access to relevant information, potentially leading to increased contributions to the Scroll project.
|
Hello Devs! @georgehao @colinlyguo @Thegaram @sbaizet-ledger @yiweichi @0xmountaintop @zimpha My PR is ready for review and merge! Thanks! |
intls
changed the title
Purpose or design rationale of this PR
Closes #1544
In the scroll project documentation, specifically in the CONTRIBUTING.md file, there are two references that are formatted to look like clickable links but are not functional:
Added the appropriate links to the official GitHub documentation for fork and pull requests:
Fork
Pull Request
PR title
Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:
Deployment tag versioning
Has
tagincommon/version.gobeen updated or have you addedbump-versionlabel to this PR?Breaking change label
Does this PR have the
breaking-changelabel?Summary by CodeRabbit
CONTRIBUTING.mdfile to enhance clarity and accessibility for contributors.