chore: add sponsors and contributors to README #1070
Conversation
WalkthroughWalkthroughThis update introduces a section dedicated to showcasing sponsors and contributors, complete with images and links, in the README.md. It aims to encourage sponsorship by highlighting the specific purposes for contributions and enhances the documentation by including links to contributors and documentation graphs. Changes
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}
| @@ -224,7 +224,35 @@ Join our [discord server](https://discord.gg/Ykhr738dUe) for chat and updates! | |||
|
|
|||
| If you like ZenStack, join us to make it a better tool! Please use the [Contributing Guide](CONTRIBUTING.md) for details on how to get started, and don't hesitate to join [Discord](https://discord.gg/Ykhr738dUe) to share your thoughts. | |||
|
|
|||
| Please also consider [sponsoring our work](https://github.com/sponsors/zenstackhq) to speed up the development of ZenStack. Thank you! | |||
| 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. | |||
There was a problem hiding this comment.
The encouragement for sponsorship is well-placed and clearly communicates the purpose of contributions. However, it might be beneficial to include more specific examples of how contributions have been used in the past or plans for future use to provide potential sponsors with a clearer picture of their impact.
| ## 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> |
There was a problem hiding this comment.
The sponsors section is a great addition, visually acknowledging those who support the project. It's important to ensure that the images and links are kept up-to-date. Consider automating this process if possible to reduce manual maintenance.
| ## 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> |
There was a problem hiding this comment.
The contributors section effectively uses images from contrib.rocks to showcase contributors. This is a nice touch that adds visual appeal to the README. Ensure that the links are regularly checked to prevent 404 errors, as contributor profiles or repositories might change over time.
Summary by CodeRabbit