Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: updated broken links for fork/pr #1545

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

intls
Copy link

@intls intls commented Oct 18, 2024

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:

  1. “Fork and clone the repository” - The word “fork” is highlighted as a link, but does not actually contain a valid URL.
  2. “Push to your fork and submit a pull request” - The phrase “submit a pull request” is also highlighted as a link, but it is 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:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

  • No, this PR doesn't involve a new deployment, git tag, docker image tag
  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change
  • Yes

Summary by CodeRabbit

  • Documentation
    • Updated the CONTRIBUTING.md file to enhance clarity and accessibility for contributors.
    • Added direct links to GitHub documentation for "Fork" and "Submit a pull request" sections.
    • Improved wording for better readability while retaining the document's structure.

Copy link

coderabbitai bot commented Oct 18, 2024

Walkthrough

The changes in this pull request involve modifications to the CONTRIBUTING.md file. The updates aim to enhance clarity and accessibility for contributors by adding direct URLs to GitHub documentation for the "Fork" and "Submit a pull request" sections. Additionally, minor wording adjustments were made to improve readability, while the overall structure of the document remains unchanged.

Changes

File Change Summary
CONTRIBUTING.md Updated links for "Fork" and "Submit a pull request" sections to direct URLs; improved wording for clarity.

Assessment against linked issues

Objective Addressed Explanation
Fix broken links in CONTRIBUTING.md (1544)

Poem

🐇 In the land of code where rabbits play,
Links now lead the right way!
Fork and pull with ease and cheer,
Contributing's fun, come join us here!
With clarity bright, our paths align,
Hop along, dear friends, it's time to shine! 🌟


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 41ce22b and f6c3db3.

📒 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 guide

The changes made to the CONTRIBUTING.md file 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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@intls
Copy link
Author

intls commented Oct 18, 2024

Hello Devs! @georgehao @colinlyguo @Thegaram @sbaizet-ledger @yiweichi @0xmountaintop @zimpha My PR is ready for review and merge! Thanks!

@intls intls changed the title fix: updated broken links fix: updated broken links for fork/pr Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix: broken links to fork/PR
1 participant