Skip to content

docs: expand community docs: contributor - simple contribution flow a… #1730

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.

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 34 commits into from
May 13, 2025
Merged
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
b9eb2b9
docs: expand community docs: contributor - simple contribution flow a…
ezinneanne Feb 17, 2025
e117d25
Merge branch 'asyncapi:master' into new-branch
ezinneanne Mar 10, 2025
d5a7881
Remove recommended-tools.md from PR
ezinneanne Mar 10, 2025
f25ec0e
updated the contribution document
ezinneanne Mar 10, 2025
642d7fb
Merge branch 'asyncapi:master' into new-branch
ezinneanne Mar 14, 2025
dc74284
made the requested changes
ezinneanne Mar 14, 2025
c408359
Merge branch 'master' into new-branch
thulieblack Mar 26, 2025
91c3633
Merge branch 'master' into new-branch
thulieblack Mar 27, 2025
6f44317
Merge branch 'master' into new-branch
thulieblack Apr 2, 2025
00d2ccb
Merge branch 'asyncapi:master' into new-branch
ezinneanne Apr 7, 2025
905c0d7
made the requested changes
ezinneanne Apr 7, 2025
3cc4ab7
Merge branch 'master' into new-branch
thulieblack Apr 8, 2025
757113f
Merge branch 'asyncapi:master' into new-branch
ezinneanne Apr 10, 2025
357ecee
made requested changes
ezinneanne Apr 10, 2025
f158fa5
Merge branch 'asyncapi:master' into new-branch
ezinneanne Apr 15, 2025
9da16c1
hardcoded the link
ezinneanne Apr 15, 2025
5bffa7d
Merge branch 'master' into new-branch
thulieblack Apr 23, 2025
ffc96f7
Made the requested changes
ezinneanne Apr 25, 2025
3cd8ed5
Merge branch 'new-branch' of https://github.com/ezinneanne/community …
ezinneanne Apr 25, 2025
c5433ab
Merge branch 'asyncapi:master' into new-branch
ezinneanne May 1, 2025
fe8e455
made requested changes
ezinneanne May 6, 2025
d5337b4
Merge branch 'asyncapi:master' into new-branch
ezinneanne May 6, 2025
42aab7a
made the requested changes
ezinneanne May 6, 2025
415cbd6
Merge branch 'asyncapi:master' into new-branch
ezinneanne May 8, 2025
ab21f21
made the requested changes
ezinneanne May 8, 2025
c3757f3
Merge branch 'master' into new-branch
thulieblack May 8, 2025
389094c
minot grammar update
thulieblack May 8, 2025
70a7783
untick the checklist
thulieblack May 8, 2025
9d1c933
made changes
ezinneanne May 9, 2025
d088ea0
Merge branch 'asyncapi:master' into new-branch
ezinneanne May 12, 2025
7012490
made changes
ezinneanne May 12, 2025
0e84b8a
Update contribution-flow.md
thulieblack May 13, 2025
9088c62
Update docs/onboarding-guide/contribution-flow.md
thulieblack May 13, 2025
4fa2860
Update contribution-flow.md
thulieblack May 13, 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
82 changes: 82 additions & 0 deletions docs/onboarding-guide/contribution-flow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Simple contribution flow for contributors
weight: 130
---

# Simple Contribution Flow
Comment on lines +1 to +6
Copy link

Choose a reason for hiding this comment

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

🛠️ 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).

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
We welcome your contributions to AsyncAPI, whether you have suggestions, improvements, or new ideas.

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

### 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).
- [Attend meetings](https://www.asyncapi.com/community/events) and engage in discussions in the [`#11_contributing` Slack channel](https://asyncapi.com/slack-invite).
- Read the [documentation](https://www.asyncapi.com/docs) to learn more about AsyncAPI.

### Before Making a Contribution
- Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide).
- If you are contributing to the community repository, review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist).
Comment on lines +21 to +22
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix broken onboarding guide links

The links in the “Before Making a Contribution” section point to /docs/community/onboarding-guide, but the actual path is /docs/onboarding-guide. Please update both links:

- 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).

Committable suggestion skipped: line range outside the PR's diff.

- 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 understand the repository better.
- Check the [general roadmap](https://www.asyncapi.com/roadmap).

### Steps to making a good contribution
Copy link
Contributor

Choose a reason for hiding this comment

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

Please make a numbered list in this section, not bullets, because the order here actually matters.

1. Set up your workflow environment using the [git workflow guide](/asyncapi/community/blob/master/git-workflow.md).
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).
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Scope "good first issues" search to AsyncAPI repo

The current URL points to GitHub’s global issues but is not scoped to AsyncAPI. 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
📝 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.

Suggested change
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).

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).
4. If you noticed a bug, typo, or needed improvement, feel free to create an issue.
5. **Make a PR only after a maintainer assigned the issue to you or asks you to work on it** even if you created the issue yourself.
6. Follow the [conventional commits guide](conventional-commits) to write a good PR title.
7. Follow the [git workflow document](/asyncapi/community/blob/master/git-workflow.md) when working on your changes and making a PR.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
7. Follow the [git workflow document](/asyncapi/community/blob/master/git-workflow.md) when working on your changes and making a PR.
7. Follow the [git workflow document](conventional-commits) when working on your changes and making a PR.

Copy link
Member

Choose a reason for hiding this comment

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

It will open once merged so don't worry

Copy link
Contributor

Choose a reason for hiding this comment

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

@thulieblack Hmm, the link to the git workflow document was correct, could you please elaborate on this suggestion?

Copy link
Member

Choose a reason for hiding this comment

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

The link shouldn't take them to the folder in GitHub but to the doc on the website. For example, how we did with the checklist https://github.com/asyncapi/community/blob/master/docs/onboarding-guide/docs-onboarding-checklist.md?plain=1

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, I got it. But this link was referring to the git workflow document that isn't listed on the docs website, that's why it was a direct link to GitHub markdown. Conventional commits is a different document, I believe we will confuse readers with such a substitution.

Copy link
Member

Choose a reason for hiding this comment

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

Then should we bring git workflow under the onboarding docs then? @bandantonio

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@thulieblack you may be using wrong link here. It should be git-workflow instead of conventional-commits

8. After making a PR, patiently wait for reviews.
9. Make sure all your PR checks pass (turn green) to speed up the merging process.
10. If your PR hasn’t been reviewed after **a week and a half**, you can gently remind a maintainer on Slack or GitHub. Delays can happen for various reasons, but no one is ignoring you! 🙏🏼 .

## Important Contribution Rules
To help maintain a welcoming and productive environment, we have outlined a few important contribution rules that all contributors, especially new ones, must follow.

These rules are here to help you succeed and to support the maintainers and community as we all work together. Not following them can lead to consequences, such as being blocked from submitting PRs or being removed from the community.

### ✅ What You Should Always Do

- **Be patient**. Maintainers are volunteers with their jobs, families, and responsibilities. It may take time for your PR or issue to be reviewed.
- **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](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).
- **Respect others**. Treat everyone with kindness and patience. We are all here to learn and grow together.

### ❌ What You Should Never Do
- Ignore essential onboarding materials and contribution guidelines.
- Tag maintainers repeatedly or demand attention.
- Post the same message in multiple places.
- Expect instant replies.

### ⚠️ What Happens If You Break the Rules

We're friendly and welcoming, but we also value focus and respect. If rules are ignored:

- You may be muted or temporarily removed from Slack.
- Repeated behavior could lead to permanent removal from the community.
- PRs or issues may be closed or rejected if the behavior affects maintainers or the community.

These rules are not meant to scare anyone - they're here to make sure everyone can enjoy a healthy and respectful space. When in doubt, be thoughtful, ask questions politely, and refer to our onboarding and etiquette docs.

Let's keep AsyncAPI a community where people enjoy contributing. 👏🏼


## Contribution Checklist
Before submitting your contribution, ask yourself:
- [ ] Is my contribution relevant to AsyncAPI?
- [ ] Have I explained why this contribution is necessary?
- [ ] Is my writing clear, concise, and well-structured?
- [ ] Did I follow the [documentation style guide](https://github.com/asyncapi/community/tree/master/docs/styleguide)?
- [ ] Have my code examples been tested, and are they functional?
- [ ] Have I linked any relevant issues, discussions, or existing docs?
- [ ] Did I provide a description of the changes in my PR?
- [ ] Am I open to feedback and revisions?

If you answered **yes** to all these questions, you are ready to submit your PR or create an issue! 🚀