docs(community): update latest community documentation #4080
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
WalkthroughA new documentation file has been introduced to the community onboarding guide, detailing the Conventional Commits standard. This guide provides contributors with instructions on how to structure commit messages and pull request titles according to the Conventional Commits specification. It covers the rationale, required formatting, examples, and additional tips, as well as links to external resources for further reference. Changes
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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
Documentation and Community
|
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4080 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 733 733
Branches 121 121
=========================================
Hits 733 733 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
asyncapi-bot
deleted the
update-community-docs-9d31eb0c5534ab2c00daf0d5fc319e83161704ff
branch
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
markdown/docs/community/onboarding-guide/conventional-commits.md (5)
13-15: Clarify “imperative” in TL;DR. It may help to specify “imperative mood” for clarity, e.g.,
- Use imperative mood and clear, concise language.
25-27: Fix blockquote formatting. Add>before the blank line to keep the two lines in the same blockquote, or remove the blank line altogether. For example:> **Bad:** `fixed bug` > > **Good:** `fix: resolve timeout issue on login by renewing session tokens`🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
26-26: Blank line inside blockquote
null(MD028, no-blanks-blockquote)
35-41: Typographical cleanup.
- Change “missing semi-colons” → “missing semicolons”.
- Optionally change “white-space” → “whitespace” for consistency.
🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb for a more formal wording.
Context: ...s type is for bug fixes. If your change corrects an issue or resolves a problem, you sho...(FIX_RESOLVE)
[misspelling] ~38-~38: This word is normally spelled as one.
Context: ...ample, white-space, formatting, missing semi-colons, etc. - refactor: Use the `refactor...(EN_COMPOUNDS_SEMI_COLONS)
62-66: Improve commit body example. Rather than showing “(blank line)”, illustrate the blank line as an actual empty>line. For example:> feat: add user avatar upload feature to improve user experience on profile pages > > Adds a form field, validation checks, and an API endpoint for avatar uploads. Enhances profile customization.
68-74: Consider expanding commit types. You might add optional types likeperf(performance),ci(continuous integration), orbuildto cover performance tweaks, CI changes, and build updates for a more exhaustive guide.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/community/onboarding-guide/conventional-commits.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
markdown/docs/community/onboarding-guide/conventional-commits.md
[style] ~36-~36: Consider using a different verb for a more formal wording.
Context: ...s type is for bug fixes. If your change corrects an issue or resolves a problem, you sho...
(FIX_RESOLVE)
[misspelling] ~38-~38: This word is normally spelled as one.
Context: ...ample, white-space, formatting, missing semi-colons, etc. - refactor: Use the `refactor...
(EN_COMPOUNDS_SEMI_COLONS)
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/community/onboarding-guide/conventional-commits.md
26-26: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (4)
markdown/docs/community/onboarding-guide/conventional-commits.md (4)
1-5: Frontmatter metadata is well-configured. Title, description, and weight fields are correctly formatted and will integrate smoothly into the docs site.
29-34: Section header and intro are clear. The “Choosing the right commit type” section sets expectations nicely.
43-46: PR-title linting guidance is concise. The link to the lint-bot workflow and the explanation of rejection criteria are spot on.
49-53: Bad/Good example table is well-formatted. It clearly demonstrates the naming convention and will help contributors craft compliant PR titles.
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit