docs: add section on types of contributions #1999
Conversation
…utions Signed-off-by: Christine Belzie <shecoder30@gmail.com>
CBID2
requested review from
bandantonio,
derberg,
asyncapi-bot-eve and
thulieblack
as code owners
WalkthroughAdded a new "Types of Contributions" subsection to the contribution-flow documentation that lists multiple contribution areas (with emojis, examples, and getting-started pointers); file content otherwise unchanged and no code or exported/public declarations were modified. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related issues
Suggested reviewers
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches🧪 Generate unit tests
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. Comment |
![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 (2)
docs/010-contribution-guidelines/contribution-flow.md (2)
14-17: Avoid content-drift with the README — consider linking instead of duplicating.The new “Types of Contributions” text largely duplicates the section already present in the repository’s main README. Keeping two copies will almost certainly diverge over time.
A lighter approach is to keep the canonical version in one place (README) and link to it here.-### Types of Contributions - -Contrary to popular belief, **contributions are not limited to code**. At AsyncAPI, we encourage contributions in all areas of the project. Below is a table of contributions that you can make: +### Types of Contributions + +> 💡 This section intentionally mirrors the “Contribute to AsyncAPI” part of the main README so new contributors don’t have to jump back and forth. +> If you update the list, please update both places (or better, replace this block with a link to avoid content drift).
18-29: Table formatting & accessibility nits
- The first column is centred with
:-----:. Markdown centre-alignment requires:---:instead – most renderers will currently left-align.- Emojis have no fallback text. Screen-reader users will only hear “graphic”. Add an
<span class="sr-only">Code</span>style fallback or append the text after the emoji.- For consistency, every row except “Testing”, “Design”, “Localization” lacks quick links (e.g. Figma board, Crowdin project). Either add links or drop them from all rows.
-| Emoji | Contribution Area | Examples & How to Get Started | -|:-----:|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Emoji | Contribution Area | Examples & How to Get Started | +|:---:|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|(Repeat for each header if you keep centred alignment.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/010-contribution-guidelines/contribution-flow.md(1 hunks)
🧠 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/010-contribution-guidelines/contribution-flow.md (1)
Learnt from: thulieblack
PR: #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.
🧰 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/010-contribution-guidelines/contribution-flow.md (1)
Learnt from: thulieblack
PR: #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.
🔇 Additional comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
18-20: Verify org-wide “good first issue” search queryThe query
https://github.com/issues?q=is%3Aopen+org%3Aasyncapi+label%3A%22good+first+issue%22is correct but returns up to 100 results and sometimes times out. You might prefer linking to the GitHub Saved Search or adding thesort:updated-descqualifier used elsewhere.
| | Emoji | Contribution Area | Examples & How to Get Started | | ||
| |:-----:|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | 💻 | Code | Fix bugs, add features, improve performance. See [good first issues](https://github.com/issues?q=is%3Aopen+org%3Aasyncapi+label%3A%22good+first+issue%22) or [open an issue](https://github.com/asyncapi/community/issues/new/choose). | | ||
| | 📝 | Documentation | Improve docs, fix typos, clarify guides. Check [docs issues](https://github.com/asyncapi/community/issues) or suggest changes directly. | |
There was a problem hiding this comment.
Docs have a different emoji
| |:-----:|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | 💻 | Code | Fix bugs, add features, improve performance. See [good first issues](https://github.com/issues?q=is%3Aopen+org%3Aasyncapi+label%3A%22good+first+issue%22) or [open an issue](https://github.com/asyncapi/community/issues/new/choose). | | ||
| | 📝 | Documentation | Improve docs, fix typos, clarify guides. Check [docs issues](https://github.com/asyncapi/community/issues) or suggest changes directly. | | ||
| | 🧪 | Testing | Test features, report bugs, improve test coverage. | |
There was a problem hiding this comment.
Tests have a different emoji
| | 🧪 | Testing | Test features, report bugs, improve test coverage. | | ||
| | 🎨 | Design | Propose UI/UX improvements, contribute graphics, review design discussions. | | ||
| | 💬 | Community Support | Answer questions on [Slack](https://asyncapi.com/slack-invite) or GitHub Discussions, help new contributors. | | ||
| | 📢 | Advocacy | Write blog posts, give talks, share AsyncAPI in your network. | |
There was a problem hiding this comment.
Writing blog posts is not advocacy - it is another contribution type that is not listed here
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
36-36: Consider adding missing contribution types (e.g., Advocacy, Ideas, Security)
The current table still omits some common categories from the all-contributors list (📣 Advocacy, 💡 Ideas, 🔒 Security, etc.). Adding them will make the guidance more complete.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/010-contribution-guidelines/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/010-contribution-guidelines/contribution-flow.md (1)
Learnt from: thulieblack
PR: #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/010-contribution-guidelines/contribution-flow.md
[style] ~33-~33: Try using a synonym here to strengthen your writing.
Context: ... | Review | Review PRs, give feedback, help maintain code quality. ...
(GIVE_PROVIDE)
🪛 markdownlint-cli2 (0.17.2)
docs/010-contribution-guidelines/contribution-flow.md
16-16: Multiple headings with the same content
(MD024, no-duplicate-heading)
36-36: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
29-32: Align emojis with the all-contributors specification
Event Organizationshould use 📆 andInfrastructureshould use ⚙️ to stay consistent with the canonical emoji-key.-| 🤝 | Event Organization | Organize or participate in meetups, workshops, or community calls. | +| 📆 | Event Organization | Organize or participate in meetups, workshops, or community calls. | -| 📦 | Infrastructure | Improve build tools, deployment scripts, or automation. | +| ⚙️ | Infrastructure | Improve build tools, deployment scripts, or automation. |
🧹 Nitpick comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
34-34: Add trailing pipe to fix MD055 table-pipe-style violationRow is missing the closing
|, breaking table formatting.-| 📝 | Examples | Create or improve code examples, sample projects, or demos. +| 📝 | Examples | Create or improve code examples, sample projects, or demos. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/010-contribution-guidelines/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/010-contribution-guidelines/contribution-flow.md (1)
Learnt from: thulieblack
PR: #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/010-contribution-guidelines/contribution-flow.md
[style] ~31-~31: Try using a synonym here to strengthen your writing.
Context: ... | Review | Review PRs, give feedback, help maintain code quality. ...
(GIVE_PROVIDE)
🪛 markdownlint-cli2 (0.17.2)
docs/010-contribution-guidelines/contribution-flow.md
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
🔇 Additional comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
1-6: Check for duplicated or orphaned contribution-flow docsA previous learning notes the canonical path as
docs/onboarding-guide/contribution-flow.md.
Adding a second copy underdocs/010-contribution-guidelines/risks divergence and broken internal links.
Confirm whether this file should replace the original or the original should be removed, and update all inbound links accordingly.
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 (2)
docs/010-contribution-guidelines/contribution-flow.md (2)
29-29: Use the canonical all-contributors emoji for “Event Organization”The spec lists 📆 (
:calendar:) rather than 🤝.
Using the wrong emoji will break automation that parses contributor types.-| 🤝 | Event Organization | Organize or participate in meetups, workshops, or community calls. | +| 📆 | Event Organization | Organize or participate in meetups, workshops, or community calls. |
32-32: Align “Infrastructure” emoji with the all-contributors specReplace 📦 with ⚙️ (
:gear:) to stay consistent with tooling that recognises contribution types.-| 📦 | Infrastructure | Improve build tools, deployment scripts, or automation. | +| ⚙️ | Infrastructure | Improve build tools, deployment scripts, or automation. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/010-contribution-guidelines/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/010-contribution-guidelines/contribution-flow.md (1)
Learnt from: thulieblack
PR: #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/010-contribution-guidelines/contribution-flow.md
[style] ~31-~31: Try using a synonym here to strengthen your writing.
Context: ... | Review | Review PRs, give feedback, help maintain code quality. ...
(GIVE_PROVIDE)
🪛 markdownlint-cli2 (0.17.2)
docs/010-contribution-guidelines/contribution-flow.md
34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
34-34: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
Hi @bandantonio. I made the changes! :) |
thulieblack
changed the title
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
16-17: Tighten wording“…a table of contributions that you can make:” → the “that” is redundant.
-Below is a table of contributions that you can make: +Below is a table of contributions you can make:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/010-contribution-guidelines/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/010-contribution-guidelines/contribution-flow.md (2)
Learnt from: thulieblack
PR: #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.
Learnt from: bandantonio
PR: #2011
File: docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md:17-19
Timestamp: 2025-07-28T23:09:06.895Z
Learning: In AsyncAPI mentorship project ideas documents, there are typically two tables: the first shows selected/featured projects (subset) and the second shows all available projects (complete list). Duplication between these tables is intentional and serves to highlight important projects while maintaining completeness.
🪛 LanguageTool
docs/010-contribution-guidelines/contribution-flow.md
[style] ~31-~31: Try using a synonym here to strengthen your writing.
Context: ... | Review | Review PRs, give feedback, help maintain code quality. ...
(GIVE_PROVIDE)
🔇 Additional comments (2)
docs/010-contribution-guidelines/contribution-flow.md (2)
1-4: Possible duplicate/relocated document pathEarlier guides live at
docs/onboarding-guide/contribution-flow.md.
Adding a second copy underdocs/010-contribution-guidelines/can confuse readers and break deep links. Please verify that this relocation is intentional and update/redirect all inbound links if necessary.
18-34: Update Translation and Examples emojis to match all-contributors specThe rows for “Translation” and “Examples” should use the canonical emojis without changing the labels:
• Replace the Translation emoji:
-| 🌐 | Translation | Translate documentation or resources into other languages. | +| 🌍 | Translation | Translate documentation or resources into other languages. |• Replace the Examples emoji:
-| 📝 | Examples | Create or improve code examples, sample projects, or demos. | +| 💡 | Examples | Create or improve code examples, sample projects, or demos. |You can verify all entries against the spec here:
https://github.com/all-contributors/all-contributors/blob/master/docs/emoji-key.md⛔ Skipped due to 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`.Learnt from: bandantonio PR: asyncapi/community#2011 File: docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md:17-19 Timestamp: 2025-07-28T23:09:06.895Z Learning: In AsyncAPI mentorship project ideas documents, there are typically two tables: the first shows selected/featured projects (subset) and the second shows all available projects (complete list). Duplication between these tables is intentional and serves to highlight important projects while maintaining completeness.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
1-4: File path deviates from canonical locationPrevious docs consistently locate the contribution-flow guide at
docs/onboarding-guide/contribution-flow.md(see long-term learning).
Adding a second copy underdocs/010-contribution-guidelines/risks divergence, broken deep-links, and duplicate SEO anchors.Recommend either:
- Move/rename this file to the canonical path, or
- Add a short stub/redirect in the old location that links here.
Keeping a single source of truth prevents future maintenance headaches.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/010-contribution-guidelines/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/010-contribution-guidelines/contribution-flow.md (2)
Learnt from: thulieblack
PR: #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.
Learnt from: bandantonio
PR: #2011
File: docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md:17-19
Timestamp: 2025-07-28T23:09:06.895Z
Learning: In AsyncAPI mentorship project ideas documents, there are typically two tables: the first shows selected/featured projects (subset) and the second shows all available projects (complete list). Duplication between these tables is intentional and serves to highlight important projects while maintaining completeness.
🪛 LanguageTool
docs/010-contribution-guidelines/contribution-flow.md
[style] ~31-~31: Try using a synonym here to strengthen your writing.
Context: ... | Review | Review PRs, give feedback, help maintain code quality. ...
(GIVE_PROVIDE)
🔇 Additional comments (2)
docs/010-contribution-guidelines/contribution-flow.md (2)
18-34: LGTM on formatting & duplicate-heading fixThe duplicate
### Types of Contributionsheading is gone, pipe style is now consistent, and a blank line follows the table—markdown-lint passes. Nice clean-up!
18-34: Verify all-contributors emoji mappings for Translation and InfrastructureI wasn’t able to locate any custom emoji overrides in
.all-contributorsrcor fetch the CLI’s defaultemoji.json. Please double-check the official all-contributors emoji key (https://allcontributors.org/docs/en/emoji-key) and ensure the table uses the canonical emojis:• Translation row should use 🌍
• Infrastructure row should use 🚀 (or 🚇 if specified in your bot config)Update either the markdown table in
docs/010-contribution-guidelines/contribution-flow.mdor your all-contributors configuration to keep badges working correctly.
Co-authored-by: Antonio <bandantonio@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/010-contribution-guidelines/contribution-flow.md (2)
34-36: Add a blank line after the table to satisfy MD058
Markdown-lint still flagsblanks-around-tablesbecause the heading starts immediately after the closing table row.-| 📝 | Examples | Create or improve code examples, sample projects, or demos. | +| 📝 | Examples | Create or improve code examples, sample projects, or demos. | +
1-4: File placed outside the established onboarding docs tree
Previous PRs standardized contribution-flow docs under
docs/onboarding-guide/contribution-flow.md(see learning note).
Introducing a second copy atdocs/010-contribution-guidelines/risks duplication and link rot.Consider either
- moving this file to the original path, or
- replacing the old file with a redirect/front-matter alias.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/010-contribution-guidelines/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/010-contribution-guidelines/contribution-flow.md (2)
Learnt from: thulieblack
PR: #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.
Learnt from: bandantonio
PR: #2011
File: docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md:17-19
Timestamp: 2025-07-28T23:09:06.895Z
Learning: In AsyncAPI mentorship project ideas documents, there are typically two tables: the first shows selected/featured projects (subset) and the second shows all available projects (complete list). Duplication between these tables is intentional and serves to highlight important projects while maintaining completeness.
🪛 LanguageTool
docs/010-contribution-guidelines/contribution-flow.md
[style] ~31-~31: Try using a synonym here to strengthen your writing.
Context: ... | Review | Review PRs, give feedback, help maintain code quality. ...
(GIVE_PROVIDE)
🔇 Additional comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
18-34: Align emojis & labels to all-contributors canonical set
docs/010-contribution-guidelines/contribution-flow.md (lines 18–34):• Project Management
– change emoji 🗂️ → 📆
– update Contribution Area text toprojectManagement
• Translation
– change emoji 🌐 → 🌍
– update Contribution Area text totranslation
• Content
– change emoji 📢 → 🖋 (usecontent) or 📝 (useblog), depending on whether this row is “website copy” vs “blogposts”
• Plugin/Tool Creation
– change emoji 🔌 → 🔧
– update Contribution Area text totoolPlease cross-check all rows against the all-contributors emoji-key (https://github.com/all-contributors/all-contributors/blob/master/docs/emoji-key.md) and ensure each emoji and label exactly matches the lower-camelCase identifier.
⛔ Skipped due to 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`.Learnt from: bandantonio PR: asyncapi/community#2011 File: docs/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md:17-19 Timestamp: 2025-07-28T23:09:06.895Z Learning: In AsyncAPI mentorship project ideas documents, there are typically two tables: the first shows selected/featured projects (subset) and the second shows all available projects (complete list). Duplication between these tables is intentional and serves to highlight important projects while maintaining completeness.
| | 💻 | Code | Fix bugs, add features, refactor code, improve performance. See [good first issues](https://github.com/issues?q=is%3Aopen+org%3Aasyncapi+label%3A%22good+first+issue%22) or [open an issue](https://github.com/asyncapi/community/issues/new/choose). | | ||
| | 📖 | Documentation | Improve docs, fix typos, clarify guides, update README. Check [docs issues](https://github.com/asyncapi/community/issues) or suggest changes directly. | | ||
| | 🐛 | Bug Reports | Report bugs, help reproduce issues, suggest fixes. [Open a bug issue](https://github.com/asyncapi/community/issues/new?assignees=&labels=bug&template=bug_report.md). | | ||
| | 🧪 | Tests | Add or improve tests, increase coverage, verify fixes. | |
There was a problem hiding this comment.
This item is still Inconsistent with that specified in the all-contributors
| | 🐛 | Bug Reports | Report bugs, help reproduce issues, suggest fixes. [Open a bug issue](https://github.com/asyncapi/community/issues/new?assignees=&labels=bug&template=bug_report.md). | | ||
| | 🧪 | Tests | Add or improve tests, increase coverage, verify fixes. | | ||
| | 🎨 | Design | Propose UI/UX improvements, contribute graphics, review design discussions. | | ||
| | 💬 | Community Support | Answer questions on [Slack](https://asyncapi.com/slack-invite) or GitHub Discussions, help new contributors, provide mentorship. | |
There was a problem hiding this comment.
This item is still Inconsistent with that specified in the all-contributors
| | 🧪 | Tests | Add or improve tests, increase coverage, verify fixes. | | ||
| | 🎨 | Design | Propose UI/UX improvements, contribute graphics, review design discussions. | | ||
| | 💬 | Community Support | Answer questions on [Slack](https://asyncapi.com/slack-invite) or GitHub Discussions, help new contributors, provide mentorship. | | ||
| | 📢 | Content | Write blog posts, tutorials, guides, or examples about AsyncAPI. Share in your network or submit to [AsyncAPI blog](https://www.asyncapi.com/blog). | |
There was a problem hiding this comment.
This item is still Inconsistent with that specified in the all-contributors
| | 🎨 | Design | Propose UI/UX improvements, contribute graphics, review design discussions. | | ||
| | 💬 | Community Support | Answer questions on [Slack](https://asyncapi.com/slack-invite) or GitHub Discussions, help new contributors, provide mentorship. | | ||
| | 📢 | Content | Write blog posts, tutorials, guides, or examples about AsyncAPI. Share in your network or submit to [AsyncAPI blog](https://www.asyncapi.com/blog). | | ||
| | 🗂️ | Project Management | Triage issues, review PRs, organize tasks and workflows, help with releases. | |
There was a problem hiding this comment.
This item is still Inconsistent with that specified in the all-contributors
| | 💬 | Community Support | Answer questions on [Slack](https://asyncapi.com/slack-invite) or GitHub Discussions, help new contributors, provide mentorship. | | ||
| | 📢 | Content | Write blog posts, tutorials, guides, or examples about AsyncAPI. Share in your network or submit to [AsyncAPI blog](https://www.asyncapi.com/blog). | | ||
| | 🗂️ | Project Management | Triage issues, review PRs, organize tasks and workflows, help with releases. | | ||
| | 🌐 | Translation | Translate documentation or resources into other languages. | |
There was a problem hiding this comment.
This item is still Inconsistent with that specified in the all-contributors
| | 📢 | Content | Write blog posts, tutorials, guides, or examples about AsyncAPI. Share in your network or submit to [AsyncAPI blog](https://www.asyncapi.com/blog). | | ||
| | 🗂️ | Project Management | Triage issues, review PRs, organize tasks and workflows, help with releases. | | ||
| | 🌐 | Translation | Translate documentation or resources into other languages. | | ||
| | 📆 | Event Organization | Organize or participate in meetups, workshops, or community calls. | |
There was a problem hiding this comment.
This item is still Inconsistent with that specified in the all-contributors
| | 📆 | Event Organization | Organize or participate in meetups, workshops, or community calls. | | ||
| | 🚧 | Maintenance | Help with repository upkeep, update dependencies, improve workflows, manage CI/CD. | | ||
| | 👀 | Review | Review PRs, give feedback, help maintain code quality. | | ||
| | ⚙️ | Infrastructure | Improve build tools, deployment scripts, or automation. | |
There was a problem hiding this comment.
This item is still Inconsistent with that specified in the all-contributors
| | 👀 | Review | Review PRs, give feedback, help maintain code quality. | | ||
| | ⚙️ | Infrastructure | Improve build tools, deployment scripts, or automation. | | ||
| | 🔌 | Plugin/Tool Creation | Develop plugins, integrations, or tools for AsyncAPI ecosystem. | | ||
| | 📝 | Examples | Create or improve code examples, sample projects, or demos. | |
There was a problem hiding this comment.
This item is still Inconsistent with that specified in the all-contributors
|
Promotion type is missing |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/010-contribution-guidelines/contribution-flow.md (2)
14-16: Duplicate heading resolved — good fix.The second “Types of Contributions” header is gone; MD024 is addressed.
18-34: Align emojis and keys to the official all-contributors spec and add missing “Promotion”.Several rows don’t match the canonical emoji/key (e.g., Tests, Translation, Project Management, Event Organizing, Infrastructure, Examples). Also, “Promotion” is missing. Recommend aligning names, emojis, and including the all-contributors key to avoid confusion with the bot.
Apply:
-| Emoji | Contribution Area | Examples & How to Get Started | -| :-----: | :----------------- | :---------------------------- | -| 💻 | Code | Fix bugs, add features, refactor code, improve performance. See [good first issues](https://github.com/issues?q=is%3Aopen+org%3Aasyncapi+label%3A%22good+first+issue%22) or [open an issue](https://github.com/asyncapi/community/issues/new/choose). | -| 📖 | Documentation | Improve docs, fix typos, clarify guides, update README. Check [docs issues](https://github.com/asyncapi/community/issues) or suggest changes directly. | -| 🐛 | Bug Reports | Report bugs, help reproduce issues, suggest fixes. [Open a bug issue](https://github.com/asyncapi/community/issues/new?assignees=&labels=bug&template=bug_report.md). | -| 🧪 | Tests | Add or improve tests, increase coverage, verify fixes. | -| 🎨 | Design | Propose UI/UX improvements, contribute graphics, review design discussions. | -| 💬 | Community Support | Answer questions on [Slack](https://asyncapi.com/slack-invite) or GitHub Discussions, help new contributors, provide mentorship. | -| 📢 | Content | Write blog posts, tutorials, guides, or examples about AsyncAPI. Share in your network or submit to [AsyncAPI blog](https://www.asyncapi.com/blog). | -| 🗂️ | Project Management | Triage issues, review PRs, organize tasks and workflows, help with releases. | -| 🌐 | Translation | Translate documentation or resources into other languages. | -| 📆 | Event Organization | Organize or participate in meetups, workshops, or community calls. | -| 🚧 | Maintenance | Help with repository upkeep, update dependencies, improve workflows, manage CI/CD. | -| 👀 | Review | Review PRs, give feedback, help maintain code quality. | -| ⚙️ | Infrastructure | Improve build tools, deployment scripts, or automation. | -| 🔌 | Plugin/Tool Creation | Develop plugins, integrations, or tools for AsyncAPI ecosystem. | -| 📝 | Examples | Create or improve code examples, sample projects, or demos. | +| Emoji | Contribution Area (key) | Examples & How to Get Started | +| :---: | :---------------------- | :---------------------------- | +| 💻 | Code (`code`) | Fix bugs, add features, refactor code, improve performance. See [good first issues](https://github.com/issues?q=is%3Aopen+org%3Aasyncapi+label%3A%22good+first+issue%22) or [open an issue](https://github.com/asyncapi/community/issues/new/choose). | +| 📖 | Documentation (`doc`) | Improve docs, fix typos, clarify guides, update README. Check [docs issues](https://github.com/asyncapi/community/issues) or suggest changes directly. | +| 🐛 | Bug Reports (`bug`) | Report bugs, help reproduce issues, suggest fixes. [Open a bug issue](https://github.com/asyncapi/community/issues/new?assignees=&labels=bug&template=bug_report.md). | +| ⚠️ | Tests (`test`) | Add or improve tests, increase coverage, verify fixes. | +| 🎨 | Design (`design`) | Propose UI/UX improvements, contribute graphics, review design discussions. | +| 💬 | Community Support (`question`) | Answer questions on [Slack](https://asyncapi.com/slack-invite) or GitHub Discussions; mentor newcomers. | +| 🖋 | Content (`content`) | Improve site/app copy, docs information architecture, and non-blog written content. | +| 📝 | Blog (`blog`) | Write blog posts, tutorials, or guides about AsyncAPI. Submit to the [AsyncAPI blog](https://www.asyncapi.com/blog). | +| 📆 | Project Management (`projectManagement`) | Triage issues, review PRs, organize tasks/workflows, assist with releases. | +| 📋 | Event Organizing (`eventOrganizing`) | Organize or participate in meetups, workshops, or community calls. | +| 🚧 | Maintenance (`maintenance`) | Repository upkeep, dependency updates, CI/CD workflow improvements. | +| 👀 | Review (`review`) | Review PRs, provide feedback, help maintain code quality. | +| 🚇 | Infrastructure (`infra`) | CI, hosting, build tools, and automation. | +| 🔌 | Plugin (`plugin`) | Develop plugins or integrations for the AsyncAPI ecosystem. | +| 💡 | Examples (`example`) | Create or improve code examples, sample projects, or demos. | +| 🌍 | Translation (`translation`) | Translate documentation or resources into other languages. | +| 📣 | Promotion (`promotion`) | Share AsyncAPI in talks, social media, newsletters, and communities. |Rationale: matches the official emoji-key and adds the missing Promotion type; also separates Blog from Content and fixes emojis for Tests, Translation, Project Management, Event Organizing, Infrastructure, and Examples. See the spec for the canonical mapping. (allcontributors.org)
🧹 Nitpick comments (2)
docs/010-contribution-guidelines/contribution-flow.md (2)
31-31: Minor wording tweak.“give feedback” → “provide feedback”.
-| 👀 | Review | Review PRs, give feedback, help maintain code quality. | +| 👀 | Review | Review PRs, provide feedback, help maintain code quality. |
35-35: Optional: Add a one-liner on how recognition works with @all-contributors.Add a short note after the table with the bot command, plus a link to the repo’s recognition guide.
+ +> To be recognized, comment on the PR/issue with the all-contributors bot, for example: +> `@all-contributors please add @your-username for code` +> See our recognition guide for details. +You can link to the community doc that shows the bot usage. (github.com, allcontributors.org)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/010-contribution-guidelines/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-04-29T11:49:47.903Z
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`.
Applied to files:
docs/010-contribution-guidelines/contribution-flow.md
🪛 LanguageTool
docs/010-contribution-guidelines/contribution-flow.md
[grammar] ~25-~25: There might be a mistake here.
Context: ...itHub Discussions, help new contributors, provide mentorship. ...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...review PRs, organize tasks and workflows, help with releases. ...
(QB_NEW_EN)
[style] ~31-~31: Try using a synonym here to strengthen your writing.
Context: ... | Review | Review PRs, give feedback, help maintain code quality. ...
(GIVE_PROVIDE)
|
@CBID2 any update |
Hi @thulieblack. Been busy with other stuff. Will get to my PR soon |
Signed-off-by: Christine <shecoder30@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
18-40: Align table with all-contributors spec, fix emojis, duplicates, and markdownlint issues (MD055/MD058).
- Use canonical emojis/types (e.g., Tests = ✅; Infrastructure = 🚇; Event Organizing = 📋; Reviewed PRs = 👀). (allcontributors.org)
- Remove duplicate “Examples” row, consolidate “Review” into “Reviewed Pull Requests.”
- Add missing Event Organizing row.
- Normalize trailing pipes and add a blank line after the table.
| Emoji | Contribution Area | Examples & How to Get Started | | :-----: | :----------------- | :---------------------------- | | 💻 | Code | Fix bugs, add features, refactor code, improve performance. See [good first issues](https://github.com/issues?q=is%3Aopen+org%3Aasyncapi+label%3A%22good+first+issue%22) or [open an issue](https://github.com/asyncapi/community/issues/new/choose). | | 📖 | Documentation | Improve docs, fix typos, clarify guides, update README. Check [docs issues](https://github.com/asyncapi/community/issues) or suggest changes directly. | | 🐛 | Bug Reports | Report bugs, help reproduce issues, suggest fixes. [Open a bug issue](https://github.com/asyncapi/community/issues/new?assignees=&labels=bug&template=bug_report.md). | -| ⚠️ | Tests | Add or improve tests, increase coverage, verify fixes. | +| ✅ | Tests | Add or improve tests, increase coverage, verify fixes. | | 🎨 | Design | Propose UI/UX improvements, contribute graphics, review design discussions. | -| 💬 | Answering Questions | Answer questions on [Slack](https://asyncapi.com/slack-invite) or [GitHub Issues](https://github.com/asyncapi/community/issues), help new contributors, provide mentorship. | +| 💬 | Answering Questions | Answer questions on [Slack](https://asyncapi.com/slack-invite), GitHub Issues/Discussions, help new contributors, provide mentorship. | -| 📝 | Blogposts | Write blog posts for [AsyncAPI's blog](https://www.asyncapi.com/blog). | +| 📝 | Blogposts | Write blog posts for [AsyncAPI's blog](https://www.asyncapi.com/blog). | -| 📆 | Project Management | Triage issues and organize tasks and workflows, help with releases. | +| 📆 | Project Management | Triage issues, organize tasks and workflows, help with releases. | -| 🌍 | Translation | Translate documentation or resources into other languages. | +| 🌍 | Translation | Translate documentation or resources into other languages. | -| 📣 | Promotion | Promote AsyncAPI whether it's social media and personal blogs | +| 📣 | Promotion | Promote AsyncAPI via social media, personal blogs, meetups, or newsletters. | | 🚧 | Maintenance | Help with repository upkeep, update dependencies, improve workflows, manage CI/CD. | -| 👀 | Review | Review PRs, give feedback, help maintain code quality. | +| 👀 | Reviewed Pull Requests | Review PRs, give feedback, help maintain code quality. | -| 🚇 | Infrastructure | Improve build tools, deployment scripts, or automation. | +| 🚇 | Infrastructure | Improve build tools, deployment scripts, or automation. | -| 🔌 | Plugin/Tool Creation | Develop plugins, integrations, or tools for AsyncAPI ecosystem. | +| 📋 | Event Organizing | Organize or participate in meetups, workshops, or community calls. | +| 🔌 | Plugin | Develop plugins or utility libraries for the AsyncAPI ecosystem. | +| 🔧 | Tools | Build or improve developer tools for the AsyncAPI ecosystem. | -| 🛡️ | Security | Identify and/or reduce security threats and improve the privacy of AsyncAPI whether it's the tools themselves and/or the repositories | +| 🛡️ | Security | Identify and reduce security threats; improve privacy in tools and/or repositories. | -| 👀 | Reviewed Pull Requests | Review fellow contributors' pull requests. | -| 📢 | Talks | Participate in AsyncAPI's conferences as a presenter| +| 📢 | Talks | Present at AsyncAPI conferences or community events. | -| 🤔 | Ideas & Planning | Join our community to share your suggestions to grow AsyncAPI | +| 🤔 | Ideas & Planning | Share suggestions and planning ideas to help grow AsyncAPI. | -| 💡 | Examples | Provide links to examples of AsyncAPI being used in projects | -| 💡 | Examples | Provide links to examples of AsyncAPI being used in projects | +| 💡 | Examples | Provide links to examples of AsyncAPI in real projects. | +Notes:
- Official spec: eventOrganizing = 📋, projectManagement = 📆, infra = 🚇, test = ✅, review = 👀, translation = 🌍. (allcontributors.org)
🧹 Nitpick comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
16-17: Reference the canonical emoji/type list to avoid future drift.Add a short sentence linking to the official all-contributors emoji key so maintainers and contributors know the source of truth.
Contrary to popular belief, **contributions are not limited to code**. At AsyncAPI, we encourage contributions in all areas of the project. Below is a table of contributions you can make: + +For canonical types and emojis, see the official all-contributors emoji key. This helps keep our recognition consistent with automation. +<https://allcontributors.org/docs/en/emoji-key>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/010-contribution-guidelines/contribution-flow.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-04-29T11:49:47.903Z
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`.
Applied to files:
docs/010-contribution-guidelines/contribution-flow.md
🔇 Additional comments (1)
docs/010-contribution-guidelines/contribution-flow.md (1)
47-61: Internal links resolve — no changes required.
Checked docs/010-contribution-guidelines/contribution-flow.md: ../000-onboarding, ../000-onboarding/docs-onboarding-checklist, git-workflow, and conventional-commits all point to existing files.
Made the changes |
Description
This pull request adds a section on different types of contributions that users can make to AsyncAPI and how they'll be recognized, providing more guidiance to new users.
Note
The allcontributors website does not work, so I mostly took inspiration from the Contribute to AsyncAPI section.
Related issue(s)
Closes # #1981
Relates to #1964
Summary by CodeRabbit