docs: update readme community section #1678
Conversation
WalkthroughThe changes in this pull request primarily focus on enhancing the Changes
Possibly related PRs
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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
README.md (3)
84-88: Great update to the community section!The changes effectively highlight Permify's affiliation with the Cloud Native Computing Foundation and encourage user feedback. This aligns well with the PR objectives and enhances community engagement.
Consider rephrasing the last sentence to avoid the repetitive use of "feel free to":
-Share your use case, get the latest product updates, receive immediate assistance from our team, and feel free to ask any questions about Permify or authorization in a broader context by joining our conversation on Discord! +Share your use case, get the latest product updates, receive immediate assistance from our team, and ask any questions about Permify or authorization in a broader context by joining our conversation on Discord!This small change makes the text more concise and professional while maintaining its welcoming tone.
🧰 Tools
🪛 LanguageTool
[style] ~88-~88: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...immediate assistance from our team, and feel free to ask any questions about Permify or auth...(FEEL_FREE_TO_STYLE_ME)
Line range hint
93-101: Excellent expansion of the contributing section!The detailed breakdown of contribution areas (codebase, documentation, and playground) provides clear guidance for potential contributors. This enhancement aligns well with the goal of fostering community engagement.
To improve clarity, consider adding a brief introductory sentence before listing the contribution areas:
Here are the ways to contribute to Permify: +Permify welcomes contributions in various areas, including: * **Contribute to codebase:** We're collaboratively working with our community to make Permify the best it can be! You can develop new features, fix existing issues or make third-party integrations/packages. * **Improve documentation:** Alongside our codebase, documentation one of the most significant part in our open-source journey. We're trying to give the best DX possible to explain ourselves and Permify. And you can help on that with importing resources or adding new ones. * **Contribute to playground:** Permify playground allows you to visualize and test your authorization logic. You can contribute to our playground by improving its user interface, fixing glitches, or adding new features.This addition provides a smoother transition and sets the context for the list that follows.
🧰 Tools
🪛 LanguageTool
[style] ~88-~88: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...immediate assistance from our team, and feel free to ask any questions about Permify or auth...(FEEL_FREE_TO_STYLE_ME)
Line range hint
103-107: Great addition of the Bounties section!The new Bounties section is a valuable addition that can motivate contributors and highlight specific areas where help is needed. The badge and link to bounty issues provide a clear call-to-action.
To make the section even more effective, consider adding a brief explanation of how the bounty system works:
### Bounties [](https://console.algora.io/org/permify/bounties?status=open) We have a list of [issues](https://github.com/Permify/permify/labels/%F0%9F%92%8E%20Bounty) where you can contribute and gain bounty award! Bounties will be awarded for fixing issues via accepted Pull Requests (PR). +Bounties are monetary rewards for completing specific tasks or fixing issues. The reward amount for each bounty is listed in the issue description. To claim a bounty, submit a pull request that addresses the issue and wait for it to be reviewed and accepted. Before start please see our [contributing guide](https://github.com/Permify/permify/blob/master/CONTRIBUTING.md).This addition provides more context about how the bounty system works, which can be helpful for newcomers to the project or those unfamiliar with bounty programs in open source.
🧰 Tools
🪛 LanguageTool
[style] ~88-~88: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...immediate assistance from our team, and feel free to ask any questions about Permify or auth...(FEEL_FREE_TO_STYLE_ME)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~88-~88: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...immediate assistance from our team, and feel free to ask any questions about Permify or auth...(FEEL_FREE_TO_STYLE_ME)
🔇 Additional comments (1)
README.md (1)
Line range hint
1-124: Overall, excellent updates to the README!The changes made to this file significantly improve the community engagement aspects of the project:
- The updated community section highlights Permify's affiliation with the Cloud Native Computing Foundation and encourages user feedback.
- The expanded contributing section provides clear guidance on various ways to contribute to the project.
- The new bounties section adds an incentive for contributors and highlights specific areas where help is needed.
These updates align well with the PR objectives and create a more welcoming and informative README for potential contributors and users.
🧰 Tools
🪛 LanguageTool
[style] ~88-~88: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...immediate assistance from our team, and feel free to ask any questions about Permify or auth...(FEEL_FREE_TO_STYLE_ME)
docs: update readme community section
Summary by CodeRabbit