You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/onboarding-guide/contribution-flow.md
+15-15Lines changed: 15 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -28,16 +28,16 @@ At AsyncAPI, we value **quality over quantity**. This guide will help you make m
28
28
1. Set up your workflow environment using the [git workflow guide](/asyncapi/community/blob/master/git-workflow.md).
29
29
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).
30
30
3. When you do find one, request to be assigned.
31
-
4. If you noticed a bug, typo, or a needed improvement, feel free to create an issue.
31
+
4. If you noticed a bug, typo, or needed improvement, feel free to create an issue.
32
32
5.**Make a PR only after a maintainer assigned the issue to you** even if you created the issue yourself.
33
33
6. Follow the [conventional commits guide](conventional-commits) to write a good PR title.
34
34
7. Follow the [git workflow document](/asyncapi/community/blob/master/git-workflow.md) when working on your changes and making a PR.
35
35
8. After making a PR, patiently wait for reviews.
36
36
9. Make sure all your PR checks pass (turn green) to speed up the merging process.
37
-
10. If your PR hasn’t been reviewed after **a week and half**, you can gently remind a maintainer on Slack or GitHub. Delays can happen for various reasons, but no one is ignoring you! 🙏🏼 .
37
+
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! 🙏🏼 .
38
38
39
39
## Important Contribution Rules
40
-
To help maintain a welcoming and productive environment, we have outlined a few important contribution rules that all contributors—especially new ones—must follow.
40
+
To help maintain a welcoming and productive environment, we have outlined a few important contribution rules that all contributors, especially new ones, must follow.
41
41
42
42
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.
43
43
@@ -50,10 +50,10 @@ These rules are here to help you succeed and to support the maintainers and comm
50
50
-**Respect others**. Treat everyone with kindness and patience. We are all here to learn and grow together.
51
51
52
52
### ❌ What You Should Never Do
53
-
-Don’t ignore the onboarding materials and contribution guidelines.
54
-
-Don’t tag maintainers repeatedly or demand attention.
55
-
-Don’t post the same message in multiple places.
56
-
-Don’t expect instant replies.
53
+
-Ignore essential onboarding materials and contribution guidelines.
54
+
-Tagging maintainers repeatedly or demanding attention.
55
+
-Posting the same message in multiple places.
56
+
-Expecting instant replies.
57
57
58
58
### ⚠️ What Happens If You Break the Rules
59
59
@@ -70,13 +70,13 @@ Let’s keep AsyncAPI a community where people enjoy contributing. 👏🏼
70
70
71
71
## Contribution Checklist
72
72
Before submitting your contribution, ask yourself:
73
-
-[x] Is my contribution relevant to AsyncAPI?
74
-
-[x] Have I explained why this contribution is necessary?
75
-
-[x] Is my writing clear, concise, and well-structured?
76
-
-[x] Did I follow the [documentation style guide](https://github.com/asyncapi/community/tree/master/docs/styleguide)?
77
-
-[x] Are my code examples tested and functional?
78
-
-[x] Have I linked any relevant issues, discussions, or existing docs?
79
-
-[x] Did I provide a description of the changes in my PR?
80
-
-[x] Am I open to feedback and revisions?
73
+
-[] Is my contribution relevant to AsyncAPI?
74
+
-[] Have I explained why this contribution is necessary?
75
+
-[] Is my writing clear, concise, and well-structured?
76
+
-[] Did I follow the [documentation style guide](https://github.com/asyncapi/community/tree/master/docs/styleguide)?
77
+
-[] Are my code examples tested and functional?
78
+
-[] Have I linked any relevant issues, discussions, or existing docs?
79
+
-[] Did I provide a description of the changes in my PR?
80
+
-[] Am I open to feedback and revisions?
81
81
82
82
If you answered **yes** to all these questions, you are ready to submit your PR or create an issue! 🚀
0 commit comments