docs: expand community docs: contributor - simple contribution flow a… #1730
Conversation
…nd recommended tools
ezinneanne
requested review from
quetzalliwrites,
derberg,
asyncapi-bot-eve and
thulieblack
as code owners
|
@ezinneanne separate the files into 2 PRs |
|
@thulieblack @bandantonio I have separated the PR files and also updated this contribution document by adding contribution steps and checklist. Kindly review |
There was a problem hiding this comment.
Great start Ezinne:
- your file should be under the onboarding folder and front matter
- rename file to
contribution-flow.mdfor consistency with other files - detail the whole process for the contribution flow based from the https://github.com/asyncapi/website/blob/master/CONTRIBUTING.md#contribution-flow. in your doc.
Love the checklist
making-a-contribution.md
Outdated
| @@ -0,0 +1,48 @@ | |||
| # Contributor - Simple Contribution Flow | |||
| This article explains how to contribute effectively to AsyncAPI. It guides you through the contribution process and provides a checklist to ensure high-quality contributions. | |||
There was a problem hiding this comment.
| This article explains how to contribute effectively to AsyncAPI. It guides you through the contribution process and provides a checklist to ensure high-quality contributions. | |
| This guide explains how to contribute effectively to AsyncAPI. It guides you through the contribution process and provides a checklist to ensure high-quality contributions. |
making-a-contribution.md
Outdated
|
|
||
|
|
||
| ## Making a Contribution | ||
| We welcome your contributions to AsyncAPI! Whether you have suggestions, improvements, or new ideas, we encourage you to participate. |
There was a problem hiding this comment.
| We welcome your contributions to AsyncAPI! Whether you have suggestions, improvements, or new ideas, we encourage you to participate. | |
| We welcome your contributions to AsyncAPI, whether you have suggestions, improvements, or new ideas. |
making-a-contribution.md
Outdated
| - Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide). | ||
| - If you are contributing to documentation, review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist). | ||
| - For other repositories, refer to the [general contribution guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md). | ||
| - Look through existing issues and pull requests to gain a better understanding of the repository. |
There was a problem hiding this comment.
| - Look through existing issues and pull requests to gain a better understanding of the repository. | |
| - Look through existing issues and pull requests to understand the repository better. |
making-a-contribution.md
Outdated
| - Search for [good first issues](https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22). | ||
| - When you do find one, request to be assigned. | ||
| - However, if you notice a bug, typo, or improvement, feel free to create an issue. | ||
| - Make a PR only when you have been assigned by a maintainer. |
There was a problem hiding this comment.
| - Make a PR only when you have been assigned by a maintainer. | |
| - Make a PR only when a maintainer has assigned you. |
making-a-contribution.md
Outdated
| - When you do find one, request to be assigned. | ||
| - However, if you notice a bug, typo, or improvement, feel free to create an issue. | ||
| - Make a PR only when you have been assigned by a maintainer. | ||
| - Even if you created the issue yourself, wait to be assigned by a maintainer before you make a PR. |
There was a problem hiding this comment.
| - Even if you created the issue yourself, wait to be assigned by a maintainer before you make a PR. | |
| - Even if you created the issue yourself, wait for it to be assigned by a maintainer before you make a PR. |
making-a-contribution.md
Outdated
| - However, if you notice a bug, typo, or improvement, feel free to create an issue. | ||
| - Make a PR only when you have been assigned by a maintainer. | ||
| - Even if you created the issue yourself, wait to be assigned by a maintainer before you make a PR. | ||
| - Follow the [conventional commits guide](https://github.com/asyncapi/community/pull/1733) to write a good PR title. |
There was a problem hiding this comment.
Here, we need to use a relative URL instead of the PR link
making-a-contribution.md
Outdated
| - Make a PR only when you have been assigned by a maintainer. | ||
| - Even if you created the issue yourself, wait to be assigned by a maintainer before you make a PR. | ||
| - Follow the [conventional commits guide](https://github.com/asyncapi/community/pull/1733) to write a good PR title. | ||
| - Remember to follow the [git workflow document](https://github.com/asyncapi/community/blob/master/git-workflow.md) when making a PR. |
There was a problem hiding this comment.
Same applies to the above. Use a relative URL
making-a-contribution.md
Outdated
| - Remember to follow the [git workflow document](https://github.com/asyncapi/community/blob/master/git-workflow.md) when making a PR. | ||
| - After making a PR, patiently wait for reviews. | ||
| - Make sure all your PR checks pass (turn green) to speed up the merging process. | ||
| - If your PR hasn’t been reviewed after a certain period, you can gently remind a maintainer on Slack or GitHub. Delays can happen for various reasons, but no one is ignoring you! 🙏🏼 . |
There was a problem hiding this comment.
explain they have to wait 1 1/2 weeks before pinging the maintainer on the PR and followup on Slack as last resort
|
@thulieblack I have made the changes but the relative URLs are a bit confusing as the links become inactive when I use a relative path. is there a way I could use relativ URLs and the links would still work? |
|
They'll work once we have them on the website |
|
don't forget to add the 3rd point to your doc #1730 (review) |
![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
♻️ Duplicate comments (3)
docs/onboarding-guide/contribution-flow.md (3)
21-23:⚠️ Potential issueFix broken onboarding guide links
The links point to/docs/community/onboarding-guidebut the correct path is/docs/onboarding-guide. These will 404 on the published site.Use this patch:
--- a/docs/onboarding-guide/contribution-flow.md +++ b/docs/onboarding-guide/contribution-flow.md @@ line 21 - Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide). + Read the [onboarding contributor guide](https://www.asyncapi.com/docs/onboarding-guide). @@ line 22 - review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist). + review the [documentation onboarding checklist](https://www.asyncapi.com/docs/onboarding-guide/docs-onboarding-checklist).
33-34:⚠️ Potential issueCorrect broken Conventional Commits guide link
The[conventional commits guide](conventional-commits)link is invalid in its current form. It should point to a valid URL or document path.For example:
--- a/docs/onboarding-guide/contribution-flow.md +++ b/docs/onboarding-guide/contribution-flow.md @@ line 33 - Follow the [conventional commits guide](conventional-commits) to write a good PR title. + Follow the [Conventional Commits specification](https://www.conventionalcommits.org/) to write a good PR title.
29-29:⚠️ Potential issueScope “good first issues” link to AsyncAPI/community repository
The current search URL is unscoped and returns results from all of GitHub. It should target our community repo.Patch:
--- a/docs/onboarding-guide/contribution-flow.md +++ b/docs/onboarding-guide/contribution-flow.md @@ line 29 - Search for [good first issues](https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22). + Search for [good first issues](https://github.com/asyncapi/community/issues?q=is%3Aopen+label%3A%22good+first+issue%22).
🧹 Nitpick comments (3)
docs/onboarding-guide/contribution-flow.md (3)
1-4: Align header and front matter titles
The H1 (# Simple Contribution Flow) does not match thetitlein front matter (Simple contribution flow for contributors). This can lead to inconsistent sidebar entries or broken cross-links.Apply one of the following diffs:
--- a/docs/onboarding-guide/contribution-flow.md +++ b/docs/onboarding-guide/contribution-flow.md @@ line 1-4 - title: Simple contribution flow for contributors + title: Simple Contribution Flowor
--- a/docs/onboarding-guide/contribution-flow.md +++ b/docs/onboarding-guide/contribution-flow.md @@ line 6 - # Simple Contribution Flow + # Simple contribution flow for contributors
30-30: Clarify “other repositories” reference
The phrase “For other repositories” is vague—readers won’t know which repos you’re referring to. Please list or describe those repositories explicitly.
36-36: Refine wording for “speed up”
Consider using a stronger verb to improve clarity, e.g., “accelerate” instead of “speed up”.--- a/docs/onboarding-guide/contribution-flow.md +++ b/docs/onboarding-guide/contribution-flow.md @@ line 36 - to speed up the merging process. + to accelerate the merging process.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...(SPEED_UP_ACCELERATE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
docs/onboarding-guide/contribution-flow.md (1)
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
🪛 LanguageTool
docs/onboarding-guide/contribution-flow.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...
(SPEED_UP_ACCELERATE)
🔇 Additional comments (1)
docs/onboarding-guide/contribution-flow.md (1)
27-38: Verify Mermaid diagram inclusion
The PR description mentioned mermaid.js diagrams, but no diagram code block appears in this file. Confirm whether the flow diagram was omitted or should be added under this section.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...(SPEED_UP_ACCELERATE)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/onboarding-guide/contribution-flow.md (2)
29-29:⚠️ Potential issueScope “good first issues” search to the AsyncAPI repo
The current URL searches GitHub org-wide issues. It should target our community repo for better results:- https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22 + https://github.com/asyncapi/community/issues?q=is%3Aopen+label%3A%22good+first+issue%22
21-22:⚠️ Potential issueFix broken onboarding-guide links
The links in “Before Making a Contribution” point to/docs/community/onboarding-guide, but the actual path is/docs/onboarding-guide. This will 404 once published. Please update both links accordingly:- Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide). - review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist). + Read the [onboarding contributor guide](https://www.asyncapi.com/docs/onboarding-guide). + review the [documentation onboarding checklist](https://www.asyncapi.com/docs/onboarding-guide/docs-onboarding-checklist).
🧹 Nitpick comments (4)
docs/onboarding-guide/contribution-flow.md (4)
1-4: Align front matter title with H1 heading
The YAML front matter’stitle: Simple contribution flow for contributorsdoes not exactly match the H1# Simple Contribution Flow. For consistency (and correct sidebar rendering), please unify these to the same phrase.
28-34: Remove duplicate git workflow references
Steps 1 and 7 both link to the git workflow guide. This redundancy may confuse readers—consider merging them into a single step or removing one of the references.
36-36: Consider a stronger verb
Instead of “speed up the merging process,” you might use “accelerate the merging process” for a more impactful phrasing.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...(SPEED_UP_ACCELERATE)
37-37: Remove extra space before period
There’s an unintended space before the period at the end of this sentence, resulting in “🙏🏼 .”. Please remove the space for correct punctuation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
docs/onboarding-guide/contribution-flow.md (1)
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
🪛 LanguageTool
docs/onboarding-guide/contribution-flow.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...
(SPEED_UP_ACCELERATE)
🔇 Additional comments (1)
docs/onboarding-guide/contribution-flow.md (1)
1-4: Inconsistent summary: missing Mermaid diagram
The PR description and AI summary mention the inclusion of a mermaid.js diagram to illustrate the contribution flow, but I do not see any mermaid diagram in the current file. Was the diagram intentionally removed, or should it be added back?Likely an incorrect or invalid review comment.
| - Ignore essential onboarding materials and contribution guidelines. | ||
| - Tagging maintainers repeatedly or demanding attention. | ||
| - Posting the same message in multiple places. | ||
| - Expecting instant replies. |
There was a problem hiding this comment.
Unfortunately, this update brought an inconsistency to the list. Think about the statement: "... you should never do" not "you should never be doing", so your items show follow the same pattern: ignore, tag, post, expect.
For example, check your previous list (lines 46-49) that follows this pattern: be, use, keep, follow.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
docs/onboarding-guide/contribution-flow.md (3)
29-29:⚠️ Potential issueScope “good first issues” search to AsyncAPI/community repo
The current URL searches GitHub globally and isn’t limited to the community repo. It should point directly to AsyncAPI’s community issues:- https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22 + https://github.com/asyncapi/community/issues?q=is%3Aopen+label%3A%22good+first+issue%22
33-33:⚠️ Potential issueFix broken Conventional Commits link
The[conventional commits guide](conventional-commits)link in step 6 lacks a valid URL and will 404. Update it to a proper target, for example:- [conventional commits guide](conventional-commits) + [conventional commits guide](https://www.conventionalcommits.org/)
21-22: 🛠️ Refactor suggestionUpdate broken onboarding guide links
The links in the “Before Making a Contribution” section point to/docs/community/onboarding-guide, but the live site uses/docs/onboarding-guide. These will 404 when published. Please update both URLs:- https://www.asyncapi.com/docs/community/onboarding-guide + https://www.asyncapi.com/docs/onboarding-guide
🧹 Nitpick comments (5)
docs/onboarding-guide/contribution-flow.md (5)
1-7: Align front matter title with H1 header
The front matter title (Simple contribution flow for contributors) and the H1 header (# Simple Contribution Flow) differ. This can lead to inconsistent sidebar labels and SEO titles. Please unify them to the exact same phrase. For example:- # Simple Contribution Flow + # Simple contribution flow for contributors
30-31: Clarify or remove “request to be assigned” step
Step 3 (“When you do find one, request to be assigned.”) may conflict with evolving assignment policies and could confuse new contributors. Consider rephrasing to “Comment on the issue to express interest” or removing it if explicit assignment isn’t required.
28-29: Remove duplicate git workflow reference
Steps 1 and 7 both link to the git workflow guide, leading to redundancy. Consolidate this into a single step, and update the link to point at the published docs path (e.g.,/docs/onboarding-guide/git-workflow.md).Also applies to: 34-34
36-36: Strengthen phrasing in step 9
Consider replacing “to speed up the merging process” with a more concise verb to improve readability:- to speed up the merging process + to accelerate merging🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...(SPEED_UP_ACCELERATE)
53-56: Fix grammar in “What You Should Never Do”
The verb forms in the list aren’t parallel. For example:- Tag maintainers repeatedly or demanding attention. + Tag maintainers repeatedly or demand attention.Please apply similar adjustments (e.g., “Ignore essential onboarding materials” is fine, but ensure each item starts with an imperative verb).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
docs/onboarding-guide/contribution-flow.md (1)
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
🪛 LanguageTool
docs/onboarding-guide/contribution-flow.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...
(SPEED_UP_ACCELERATE)
|
@bandantonio i have made the update. |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (5)
docs/onboarding-guide/contribution-flow.md (5)
2-7: Unify front matter title and H1 heading
The front mattertitle("Simple contribution flow for contributors") does not match the H1 heading ("Simple Contribution Flow"). This can lead to inconsistencies in the sidebar and during site generation. Please align both to the same phrase.
21-23: Fix broken "Before Making a Contribution" links
The links currently point to/docs/community/onboarding-guide, but the actual path is/docs/onboarding-guide. Update both links to:- Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide). - Review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist). + Read the [onboarding contributor guide](https://www.asyncapi.com/docs/onboarding-guide). + Review the [documentation onboarding checklist](https://www.asyncapi.com/docs/onboarding-guide/docs-onboarding-checklist).
29-29: Scope "good first issues" link to the AsyncAPI community repo
The current URL searches GitHub globally. It should target the community repository:- https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22 + https://github.com/asyncapi/community/issues?q=is%3Aopen+label%3A%22good+first+issue%22
33-33: Correct the "conventional commits guide" link
The[conventional commits guide](conventional-commits)link has no valid URL. Please update it to a proper target, for example:- [conventional commits guide](conventional-commits) + [conventional commits guide](https://www.conventionalcommits.org/)
28-34: Remove duplicate Git workflow references
Steps 1 and 7 both link to the Git workflow guide. To avoid redundancy, consider consolidating them or clarifying their distinct purposes (initial setup vs. PR creation).
🧹 Nitpick comments (3)
docs/onboarding-guide/contribution-flow.md (3)
30-30: Add missing space before parentheses
There's no space before the opening parenthesis in:comment your interest(please …Update to:
- comment your interest(please + comment your interest (please
36-36: Use a stronger verb than "speed up"
Consider replacing "speed up the merging process" with "accelerate the merging process" for more concise and formal phrasing.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...(SPEED_UP_ACCELERATE)
21-26: Ensure consistent bullet punctuation
Items under "Before You Start Contributing" end with periods, while those under "Before Making a Contribution" do not. For a cohesive style, either add periods to all list items or remove them consistently.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/onboarding-guide/contribution-flow.md (1)
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
🪛 LanguageTool
docs/onboarding-guide/contribution-flow.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...
(SPEED_UP_ACCELERATE)
|
@thulieblack @bandantonio I modified the |
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (3)
docs/onboarding-guide/contribution-flow.md (3)
29-29:⚠️ Potential issueScope "Good First Issues" Link to Community Repository
The current link is unscoped:https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22It should point specifically to the community repo, for example:
- https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22 + https://github.com/asyncapi/community/issues?q=is%3Aopen+label%3A%22good+first+issue%22
33-33:⚠️ Potential issueFix Broken "Conventional Commits" Link
The[conventional commits guide](conventional-commits)link has no valid URL and will 404. Please update it, for example:- Follow the [conventional commits guide](conventional-commits). + Follow the [conventional commits guide](https://www.conventionalcommits.org/).
21-23:⚠️ Potential issueFix Broken Onboarding Guide URLs
The links in the “Before Making a Contribution” section point to/docs/community/onboarding-guide, but the correct path is/docs/onboarding-guide. Update as follows:- Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide). - review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist). + Read the [onboarding contributor guide](https://www.asyncapi.com/docs/onboarding-guide). + Review the [documentation onboarding checklist](https://www.asyncapi.com/docs/onboarding-guide/docs-onboarding-checklist).
🧹 Nitpick comments (3)
docs/onboarding-guide/contribution-flow.md (3)
24-24: Link to Issues and Pull Requests
Consider adding hyperlinks for “existing issues and pull requests” to guide contributors directly:- Look through existing issues and pull requests to understand the repository better. + Look through [existing issues](https://github.com/asyncapi/community/issues) and [pull requests](https://github.com/asyncapi/community/pulls) to understand the repository better.
28-28: Unify Git Workflow Guide References
The Git workflow guide is referenced twice (steps 1 and 7 at lines 28 and 34), causing redundancy. Consider removing the duplicate at line 34 or merging these into a single, later step. Also, once the guide is published under/docs/onboarding-guide/git-workflow.md, update the link to point to the docs site instead of the raw GitHub path.Also applies to: 34-34
36-36: Consider Stronger Verb for Clarity
Instead of “speed up the merging process,” you could use “accelerate the merging process” for a more formal tone:- Make sure all your PR checks pass (turn green) to speed up the merging process. + Make sure all your PR checks pass (turn green) to accelerate the merging process.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...(SPEED_UP_ACCELERATE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
docs/onboarding-guide/contribution-flow.md (1)
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
🪛 LanguageTool
docs/onboarding-guide/contribution-flow.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...
(SPEED_UP_ACCELERATE)
🔇 Additional comments (1)
docs/onboarding-guide/contribution-flow.md (1)
6-7: Mermaid Diagram Missing
The PR description mentioned including a Mermaid.js diagram to illustrate the contribution flow, but the current document lacks it. If you intended to include a visual flowchart, please add it under the header. For example:
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/onboarding-guide/contribution-flow.md (3)
2-6: 🛠️ Refactor suggestionAlign document title and front matter
The H1 heading “Simple Contribution Flow” (line 6) does not match the front mattertitle: Simple contribution flow for contributors(line 2). This inconsistency can cause navigation or metadata issues on the site.
Apply one of these diffs to unify them:--- docs/onboarding-guide/contribution-flow.md @@ front matter - title: Simple contribution flow for contributors + title: Simple Contribution Flow ... - # Simple Contribution Flow + # Simple contribution flow for contributors
21-23:⚠️ Potential issueFix broken onboarding guide URLs
These links point to the outdated/docs/community/onboarding-guidepath and will 404 when published. Update them to the correct/docs/onboarding-guideURLs:@@ Before Making a Contribution - Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide). - Review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist). + Read the [onboarding contributor guide](https://www.asyncapi.com/docs/onboarding-guide). + Review the [documentation onboarding checklist](https://www.asyncapi.com/docs/onboarding-guide/docs-onboarding-checklist).
28-34:⚠️ Potential issueConsolidate steps and correct links
- Duplicate link: Steps 1 and 7 both reference the git workflow guide—consider merging or removing one to reduce redundancy.
- Good first issues URL (line 29) is unscoped. It should point to the AsyncAPI community repo:
@@ Steps to making a good contribution - 2. Search for [good first issues](https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22). + 2. Search for [good first issues](https://github.com/asyncapi/community/issues?q=is%3Aopen+label%3A%22good+first+issue%22).
- Conventional Commits link (line 33) is invalid (
conventional-commits). Use the official spec:@@ Steps to making a good contribution - 6. Follow the [conventional commits guide](conventional-commits) to write a good PR title. + 6. Follow the [Conventional Commits specification](https://www.conventionalcommits.org/) to write a clear PR title.
🧹 Nitpick comments (1)
docs/onboarding-guide/contribution-flow.md (1)
36-37: Refine wording for clarity
Consider replacing “speed up the merging process” with a more concise verb “accelerate”:@@ Steps to making a good contribution - 9. Make sure all your PR checks pass (turn green) to speed up the merging process. + 9. Make sure all your PR checks pass (turn green) to accelerate the merging process.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...(SPEED_UP_ACCELERATE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
docs/onboarding-guide/contribution-flow.md (1)
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
🪛 LanguageTool
docs/onboarding-guide/contribution-flow.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...
(SPEED_UP_ACCELERATE)
🪛 markdownlint-cli2 (0.17.2)
docs/onboarding-guide/contribution-flow.md
50-50: Unordered list style
Expected: dash; Actual: plus
(MD004, ul-style)
| - **Use the right Slack channels**. If you're unsure where to post, ask politely or take a moment to check. | ||
| - **Keep Slack tidy**. Use threads for conversations, avoid tagging `@maintainers` unless truly necessary, and don’t spam. | ||
| - Follow our [Slack etiquette](/asyncapi/community/blob/master/slack-etiquette.md) and [Code of Conduct](/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). | ||
| + Follow our [Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
Correct list bullet style and remove diff artifact
Line 50 begins with a literal “+” (a diff marker) and won’t render as a list item. Change it to a proper dash:
@@ Important Contribution Rules
- + Follow our [Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
+ - Follow our [Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| + Follow our [Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). | |
| - Follow our [Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
50-50: Unordered list style
Expected: dash; Actual: plus
(MD004, ul-style)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/onboarding-guide/contribution-flow.md (2)
33-33: 🛠️ Refactor suggestionFix broken Conventional Commits link
The[conventional commits guide](conventional-commits)link has no target and will 404. Update it to a valid URL:- 6. Follow the [conventional commits guide](conventional-commits) to write a good PR title. + 6. Follow the [conventional commits guide](https://www.conventionalcommits.org/) to write a good PR title.
29-29: 🛠️ Refactor suggestionScope "good first issues" search to the AsyncAPI community repo
The current link targets GitHub’s global issues page. It should point specifically to the community repository:- 2. Search for [good first issues](https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22). + 2. Search for [good first issues](https://github.com/asyncapi/community/issues?q=is%3Aopen+label%3A%22good+first+issue%22).
🧹 Nitpick comments (3)
docs/onboarding-guide/contribution-flow.md (3)
28-34: Consolidate duplicate Git workflow references
Steps 1 and 7 both reference the same Git workflow guide, which can confuse contributors. Consider merging them into a single instruction:-1. Set up your workflow environment using the [git workflow guide](/asyncapi/community/blob/master/git-workflow.md). ... -7. Follow the [git workflow document](/asyncapi/community/blob/master/git-workflow.md) when working on your changes and making a PR. +1. Set up and follow the [git workflow guide](/asyncapi/community/blob/master/git-workflow.md) throughout your contribution.
30-31: Rephrase assignment guidance for clarity
The current phrasing “please don't ask to be assigned” may read as discouraging. A more positive, clear alternative could be:-3. When you find one, comment on your interest and share the approach to solving the issue (please don't ask to be assigned, as it could be flagged as spam). +3. When you find one, comment to express interest and outline your approach; maintainers will assign you if it's a good fit.
36-36: Nit: use a stronger verb
Consider replacing “speed up” with a more dynamic term for clarity and impact:-9. Make sure all your PR checks pass (turn green) to speed up the merging process. +9. Make sure all your PR checks pass (turn green) to accelerate the merging process.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...(SPEED_UP_ACCELERATE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
docs/onboarding-guide/contribution-flow.md (1)
Learnt from: thulieblack
PR: asyncapi/community#1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
🪛 LanguageTool
docs/onboarding-guide/contribution-flow.md
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...all your PR checks pass (turn green) to speed up the merging process. 10. If your PR h...
(SPEED_UP_ACCELERATE)
| --- | ||
| title: Simple contribution flow for contributors | ||
| weight: 130 | ||
| --- | ||
|
|
||
| # Simple Contribution Flow |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Align front matter title with H1 heading
The title in the front matter ("Simple contribution flow for contributors") does not match the H1 heading ("Simple Contribution Flow"). For consistency in the sidebar and metadata, please align them (e.g., update the H1 to "Simple contribution flow for contributors" or vice versa).
|
/rtm |
Description
Related issue(s)
#1622
Summary by CodeRabbit