Skip to content

docs: add section on types of contributions #1999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
Oct 2, 2025
+26 −0
Merged

docs: add section on types of contributions #1999

Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
1667bb1
docs(update contribution guidelines): add section on types of contrib…
CBID2 Jul 23, 2025
d47b536
Merge branch 'master' into adding-list-of-contributions
CBID2 Jul 24, 2025
e7338ec
docs(update): revise contribution table
CBID2 Jul 26, 2025
cd6141c
Merge branch 'master' into adding-list-of-contributions
CBID2 Jul 26, 2025
d4db6c9
docs(update): fix formatting
CBID2 Jul 26, 2025
9c95a91
docs(fix): revise table
CBID2 Jul 26, 2025
0cde203
docs(update): fix the table
CBID2 Jul 26, 2025
fd8ab35
docs(update): Apply suggestion from @coderabbitai[bot]
CBID2 Jul 26, 2025
fed1189
docs(update): aligning emojis with specs
CBID2 Jul 26, 2025
6b974ce
Merge branch 'master' into adding-list-of-contributions
thulieblack Jul 30, 2025
c3cf0ad
docs(update): tighten wording
CBID2 Jul 30, 2025
408310e
docs(fixing the table): improve the chart
CBID2 Jul 30, 2025
1a5d0f4
Merge branch 'master' into adding-list-of-contributions
CBID2 Aug 3, 2025
5c4e614
Merge branch 'master' into adding-list-of-contributions
thulieblack Aug 5, 2025
e2c36d6
Merge branch 'master' into adding-list-of-contributions
CBID2 Aug 12, 2025
c93f0e5
Merge branch 'master' into adding-list-of-contributions
CBID2 Sep 2, 2025
ddf015f
Merge branch 'master' into adding-list-of-contributions
thulieblack Sep 3, 2025
52bf7f5
Merge branch 'master' into adding-list-of-contributions
thulieblack Sep 9, 2025
40e7c48
docs(contribution list): revise and update the chart
CBID2 Sep 11, 2025
c3e7c3e
Merge branch 'master' into adding-list-of-contributions
CBID2 Sep 11, 2025
7477a65
Merge branch 'master' into adding-list-of-contributions
thulieblack Sep 18, 2025
0fe1ca4
Merge branch 'master' into adding-list-of-contributions
thulieblack Sep 24, 2025
26b5ae7
Merge branch 'master' into adding-list-of-contributions
CBID2 Sep 24, 2025
5b24d3b
Merge branch 'master' into adding-list-of-contributions
CBID2 Sep 25, 2025
09351ae
docs: omit duplication
CBID2 Sep 25, 2025
6b5ec98
Merge branch 'master' into adding-list-of-contributions
CBID2 Oct 1, 2025
5e15494
Merge branch 'master' into adding-list-of-contributions
thulieblack Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/010-contribution-guidelines/contribution-flow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,32 @@ We welcome your contributions to AsyncAPI, whether you have suggestions, improve

At AsyncAPI, we value **quality over quantity**. This guide will help you make meaningful contributions that benefit the community.

### 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 you can make:

| 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. |
| 💬 | 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. |
| 📝 | 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. |
| 🌍 | Translation | Translate documentation or resources into other languages. |
| 📣 | Promotion | Promote AsyncAPI whether it's social media and personal blogs |
| 🚧 | 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. |
| 🛡️ | Security | Identify and/or reduce security threats and improve the privacy of AsyncAPI whether it's the tools themselves and/or the repositories |
| 👀 | Reviewed Pull Requests | Review fellow contributors' pull requests. |
| 📢 | Talks | Participate in AsyncAPI's conferences as a presenter|
| 🤔 | Ideas & Planning | Join our community to share your suggestions to grow AsyncAPI |
| 💡 | Examples | Provide links to examples of AsyncAPI being used in projects |

Comment on lines +18 to +39
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion | 🟠 Major

🧩 Analysis chain

Verify emoji/type alignment with all-contributors

Some mappings may still differ (e.g., Infrastructure, Plugin/Tool, Event Organizing missing). Please align exactly with the emoji-key.

🌐 Web query:

Provide the canonical emoji and labels from the all-contributors emoji-key (types and their emojis), especially for: tests, infrastructure, plugin, tool, event organizing, project management, content, blog, review.

💡 Result:

Here are the canonical all-contributors emoji keys for the requested contribution types (emoji — type keyword — label):

  • ⚠️ — test — Tests. [1]
  • 🚇 — infra — Infrastructure (hosting, build-tools, etc.). [1]
  • 🔌 — plugin — Plugin / utility libraries. [1]
  • 🔧 — tool — Tools. [1]
  • 📋 — eventOrganizing — Event Organizers. [1]
  • 📆 — projectManagement — Project Management. [1]
  • 🖋️ — content — Content (website copy; separate from blog). [1]
  • 📝 — blog — Blogposts. [1]
  • 👀 — review — Reviewed Pull Requests. [1]

Sources: All Contributors — Emoji Key. [1]

Align emojis and types with all-contributors emoji-key

  • Use ⚠️ — test, 🚇 — infra, 🔌 — plugin, 🔧 — tool, 📋 — eventOrganizing, 📆 — projectManagement, 🖋️ — content, 📝 — blog, 👀 — review.
  • Split “Plugin/Tool Creation” into separate plugin (🔌) and tool (🔧) rows.
  • Add missing Event Organizers (📋) and Content (🖋️) entries.
🤖 Prompt for AI Agents 
In docs/010-contribution-guidelines/contribution-flow.md around lines 18 to 39,
the emoji/key mapping is inconsistent with the all-contributors emoji-key and
combined Plugin/Tool row must be split; update the table to use the requested
emoji mappings: change Tests to ⚠️, Infrastructure to 🚇, Plugin to 🔌, Tool to
🔧, Event Organizing to 📋, Project Management to 📆, Content to 🖋️, Blog to
📝, Review to 👀; split the current "Plugin/Tool Creation" into two separate
rows (Plugin and Tool) with appropriate examples, and add missing Event
Organizers (📋) and Content (🖋️) rows following the same table formatting as
other entries.

### Before You Start Contributing
- If you are joining AsyncAPI through [Slack](https://asyncapi.com/slack-invite) or an event, take your time to explore the [AsyncAPI website](https://www.asyncapi.com/).
- Read our [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
Expand Down