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

chore: remove contributors docs #1719

Merged
merged 3 commits into from
Apr 13, 2024
Merged

Conversation

ezhil56x
Copy link
Contributor

@ezhil56x ezhil56x commented Apr 12, 2024

Remove contributors docs

Summary by CodeRabbit

  • Documentation
    • Updated the contribution guidelines link in the README to an external URL for better accessibility.

@github-actions github-actions bot added type: chore Routine tasks like conversions, reorganization, and maintenance work. type: docs Related to documentation and information. labels Apr 12, 2024
Copy link
Contributor

coderabbitai bot commented Apr 12, 2024

Walkthrough

The update aims to improve user guidance in the README by replacing a local link with an external URL for the contribution guidelines. This change streamlines user access to the guidelines from an external source, enhancing the overall contribution process.

Changes

File Change Summary
README.md Updated the contribution guidelines link to an external URL.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@ezhil56x
Copy link
Contributor Author

@tusharmath Made necessary changes here too!

Copy link
Contributor

@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: 0

Actionable comments outside the diff hunks (2)
README.md (2)

Line range hint 1-1: Add alt text to the Tailcall logo image for better accessibility.

- [![Tailcall](https://raw.githubusercontent.com/tailcallhq/tailcall/main/assets/logo_main.svg)](https://tailcall.run)
+ [![Tailcall Logo](https://raw.githubusercontent.com/tailcallhq/tailcall/main/assets/logo_main.svg)](https://tailcall.run)

Line range hint 56-56: Consider adding a comma after 'basically' for clarity in the sentence structure.

- So basically we specify the GraphQL schema and how to resolve that GraphQL schema in the same file, without having to write any code!
+ So, basically, we specify the GraphQL schema and how to resolve that GraphQL schema in the same file, without having to write any code!

Copy link
Contributor

@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: 0

Actionable comments outside the diff hunks (1)
README.md (1)

Line range hint 113-113: Add alternative text to the image for accessibility.

- <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=82cc2ee2-ff41-4844-9ae6-c9face103e81" />
+ <img alt="Scarf Analytics" referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=82cc2ee2-ff41-4844-9ae6-c9face103e81" />

Images should have alternate text to improve accessibility and SEO. This change adds a brief description of the image's purpose.

@tusharmath
Copy link
Contributor

@ezhil56x Can you verify if there are any back links anywhere in the project to the files that have been removed.

@ezhil56x
Copy link
Contributor Author

@tusharmath Just checked there are no back links anywhere in the project. In the main README.md there was one pointing to contributing.md which has been changed.

@amitksingh1490 amitksingh1490 enabled auto-merge (squash) April 13, 2024 13:12
@amitksingh1490 amitksingh1490 merged commit b30768c into tailcallhq:main Apr 13, 2024
27 checks passed
@ezhil56x ezhil56x deleted the contributors branch May 1, 2024 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: chore Routine tasks like conversions, reorganization, and maintenance work. type: docs Related to documentation and information.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants