Skip to content

merge dev to main (sponsors and contributors) #1071

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

Merged
merged 1 commit into from
Mar 2, 2024
Merged

merge dev to main (sponsors and contributors) #1071

merged 1 commit into from
Mar 2, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Mar 2, 2024

Summary by CodeRabbit

  • Documentation
    • Added a new section in the README for sponsors and contributors, including images and links.
    • Encouraged community sponsorship with a clear purpose.
    • Enhanced community engagement with visual representation.

Copy link
Contributor

coderabbitai bot commented Mar 2, 2024

Walkthrough

Walkthrough

This update introduces a new section in the README dedicated to showcasing sponsors and contributors, complete with images and links. It aims to encourage sponsorship by highlighting the community's support visually, thus fostering greater engagement and potentially attracting further development resources.

Changes

File(s) Change Summary
README.md Added a section for sponsors and contributors with images and links; encouraged sponsorship; enhanced community engagement through visual representation.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@ymc9 ymc9 added this pull request to the merge queue Mar 2, 2024
Merged via the queue into main with commit 8c9b80d Mar 2, 2024
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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0dfc81f and 0f9f025.
Files selected for processing (1)
  • README.md (1 hunks)

Comment on lines +227 to +255
Please also consider [sponsoring our work](https://github.com/sponsors/zenstackhq) to speed up the development. Your contribution will be 100% used as a bounty reward to encourage community members to help fix bugs, add features, and improve documentation.

## Sponsors

Thank you for your support!

<table>
<tr>
<td align="center"><a href="https://github.com/j0hannr"><img src="https://avatars.githubusercontent.com/u/52762073?v=4" width="100" style="border-radius:50%" alt="Johann Rohn"/><br />Johann Rohn</a></td>

<td align="center"><a href="https://github.com/baenie"><img src="https://avatars.githubusercontent.com/u/58309104?v=4" width="100" style="border-radius:50%" alt="Benjamin Zecirovic"/><br />Benjamin Zecirovic</a></td>
</tr>
</table>

## Contributors

Thanks to all the contributors who have helped make ZenStack better!

#### Source

<a href="https://github.com/zenstackhq/zenstack/graphs/contributors">
<img src="https://contrib.rocks/image?repo=zenstackhq/zenstack" />
</a>

#### Docs

<a href="https://github.com/zenstackhq/zenstack-docs/graphs/contributors">
<img src="https://contrib.rocks/image?repo=zenstackhq/zenstack-docs" />
</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

The addition of the sponsors and contributors section is well-executed, enhancing the README with visual acknowledgment of support. However, consider the following improvements for accessibility and consistency:

  • For images, adding alt text descriptions improves accessibility for users with screen readers. Ensure all images have meaningful alt text.
  • The use of inline styles (e.g., style="border-radius:50%") for images might not be consistent with the rest of the README styling. If the README or the project has a CSS stylesheet, consider moving styles there for maintainability.
  • Verify the links to ensure they are correct and lead to the intended profiles or pages. Broken links can detract from the user experience.
  • Encourage sponsorship with a clear call to action. The section "Please also consider sponsoring our work" is a good start, but consider making the call to action more prominent or providing more details on how sponsorship can help.

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.

1 participant