docs: add Upholding Code of Conduct document #1923
Conversation
ezinneanne
requested review from
asyncapi-bot-eve,
derberg,
quetzalliwrites and
thulieblack
as code owners
WalkthroughA new onboarding guide document has been added, detailing the AsyncAPI community's Code of Conduct, outlining contributor responsibilities, reporting procedures for violations, and providing resources for conflict resolution and community etiquette. No code or API changes are included. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@thulieblack @bandantonio I have updated the content. Kindly 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
🧹 Nitpick comments (3)
docs/onboarding-guide/upholding-code-of-conduct.md (3)
1-5: Use Title Case for Frontmatter Title
Thetitlefield should follow Title Case to be consistent with other onboarding docs. Consider updating it as follows:--- -title: Upholding code of conduct for new contributors +title: Upholding Code of Conduct for New Contributors description: This onboarding guide outlines how to uphold the code of conduct document for new contributors weight: 160 ---
15-15: Unify Spelling of "Behaviour"/"Behavior"
You’ve used both British (“behaviour” at line 15) and American (“behavior” at line 37) spellings. For consistency across the AsyncAPI docs, pick one variant (we recommend “behavior”) and apply it throughout.
40-42: Consistent Punctuation for Bullet Items
The list under “Document What Happened” contains sentence fragments that currently lack ending punctuation. To match the rest of the document’s style, add periods:- Note what was said or done + Note what was said or done. - Include context (e.g., link to a GitHub issue, Slack conversation) + Include context (e.g., link to a GitHub issue, Slack conversation). - If possible, take a screenshot + If possible, take a screenshot.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/upholding-code-of-conduct.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/onboarding-guide/upholding-code-of-conduct.md
47-47: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (2)
docs/onboarding-guide/upholding-code-of-conduct.md (2)
47-47: Bare-URL Check: No Action Needed
Althoughmarkdownlintflagged a potential bare URL, the link to the Code of Conduct Committee is properly formatted as a markdown link. No change is required here.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Bare URL used
null(MD034, no-bare-urls)
7-65: Overall Approval
This guide clearly covers contributor responsibilities, reporting steps, conflict resolution, and additional resources. After addressing the minor nitpicks above, it’s ready to merge.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Bare URL used
null(MD034, no-bare-urls)
| @@ -0,0 +1,65 @@ | |||
| --- | |||
| title: Upholding code of conduct for new contributors | |||
There was a problem hiding this comment.
| title: Upholding code of conduct for new contributors | |
| title: Upholding the code of conduct for new contributors |
|
|
||
| ## Why This Matters | ||
|
|
||
| The Code of Conduct (CoC) sets expectations for behaviour in all AsyncAPI spaces, this includes repositories, github discussions, communication platforms (Slack), and online and physical events. |
There was a problem hiding this comment.
| The Code of Conduct (CoC) sets expectations for behaviour in all AsyncAPI spaces, this includes repositories, github discussions, communication platforms (Slack), and online and physical events. | |
| The Code of Conduct (CoC) sets expectations for behavior in all AsyncAPI spaces, including repositories, GitHub discussions, communication platforms (such as Slack), and online and physical events. |
|
|
||
| Not all disagreements are violations. When conflicts happen: | ||
|
|
||
| - First, try respectful discussion or ask a neutral contributor to help mediate. |
There was a problem hiding this comment.
| - First, try respectful discussion or ask a neutral contributor to help mediate. | |
| - First, try a respectful discussion or ask a neutral contributor to help mediate. |
| Not all disagreements are violations. When conflicts happen: | ||
|
|
||
| - First, try respectful discussion or ask a neutral contributor to help mediate. | ||
| - If things escalate or become hostile, report the issue to the CoC Committee. |
There was a problem hiding this comment.
| - If things escalate or become hostile, report the issue to the CoC Committee. | |
| - If the situation escalates or becomes hostile, report the issue to the CoC Committee. |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/onboarding-guide/upholding-code-of-conduct.md (2)
57-57: 🗨️ Duplicate of earlier feedback on conflict resolution phrasing
This bullet matches a past suggestion:“First, try a respectful discussion or ask a neutral contributor to help mediate.”
58-59: 🗨️ Duplicate of earlier feedback on escalation step
This recommendation is the same as previously noted:“If the situation escalates or becomes hostile, report the issue to the CoC Committee.”
🧹 Nitpick comments (4)
docs/onboarding-guide/upholding-code-of-conduct.md (4)
2-3: Refine frontmatter description for clarity
The description reads verbatim “This onboarding guide outlines how to uphold the code of conduct document for new contributors” — consider tightening it to avoid the repeated “document” and improve readability. For example:- description: This onboarding guide outlines how to uphold the code of conduct document for new contributors + description: This guide explains how new contributors can uphold the Code of Conduct
9-10: Prefer relative links over absolute GitHub URLs
Using absolute links can lead to broken links if the repo is renamed or forked. For in-repo references, consider a relative path, e.g.:- Welcome ... our [Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md). + Welcome ... our [Code of Conduct](../CODE_OF_CONDUCT.md).
27-29: Ensure consistent title casing in bullets
The third bullet uses “Be community-oriented” (lowercase “community”) whereas the others capitalize the first word. For consistency, capitalize it:- - **Be community-oriented:** Encourage collaboration... + - **Be Community-oriented:** Encourage collaboration...
47-48: Wrap the email address in angle brackets and unify bullet style
Markdown lint (MD034) flags bare URLs and email addresses. Also align with the other bullets’ style. For example:- - Emailing **[email protected]** – this forwards directly to the [Code of Conduct Committee](https://github.com/asyncapi/community/blob/master/code_of_conduct/code-of-conduct-committee.md) + - **Email:** <[email protected]> – forwards directly to the [Code of Conduct Committee](https://github.com/asyncapi/community/blob/master/code_of_conduct/code-of-conduct-committee.md)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/upholding-code-of-conduct.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/onboarding-guide/upholding-code-of-conduct.md
47-47: Bare URL used
null
(MD034, no-bare-urls)
| @@ -0,0 +1,65 @@ | |||
| --- | |||
| title: Upholding the code of conduct for new contributors | |||
There was a problem hiding this comment.
From what I see in the AsyncAPI Code of Conduct, I believe we should be consistent in terms of naming conventions, so it should be "Code of Conduct"
@thulieblack Please correct me if I'm wrong
| - **Be community-oriented:** Encourage collaboration, help others when you can, and gracefully accept constructive criticism. | ||
| - **Speak Up:** If you witness inappropriate behavior, report it. | ||
|
|
||
| You are expected to read and understand the full [Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md) before contributing. |
There was a problem hiding this comment.
I would suggest using the abbreviated version, as you've already made the correct linking with it above
| You are expected to read and understand the full [Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md) before contributing. | |
| You are expected to read and understand the full [CoC](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md) before contributing. |
| - First, try a respectful discussion or ask a neutral contributor to help mediate. | ||
| - If the situation escalates or becomes hostile, report the issue to the CoC Committee. | ||
|
|
||
| The CoC Committee is trained to resolve conflicts fairly and ensure everyone feels safe. |
There was a problem hiding this comment.
| The CoC Committee is trained to resolve conflicts fairly and ensure everyone feels safe. | |
| The Code of Conduct Committee is trained to resolve conflicts fairly and ensure everyone feels safe. |
|
@bandantonio @thulieblack I have added the changes. Kindly review |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/onboarding-guide/upholding-code-of-conduct.md (4)
2-5: Align front matter and heading titles for consistency.The title in the front matter ("Upholding the Code of Conduct for new contributors") and the H1 heading ("Contributor Guide to Upholding the Code of Conduct") diverge slightly. Unify both—for example, use "# Upholding the Code of Conduct for New Contributors" as your single source of truth.
3-3: Remove redundant wording in description.The phrase "Code of Conduct document" is repetitive. Consider simplifying to "Code of Conduct".
27-31: Capitalize list items consistently.Change "Be community-oriented:" to "Be Community-Oriented:" so it matches the title‐case style of the other bullet points.
46-48: Convert the email to a mailto link.Static analysis flags bare URLs. Replace [email protected] with a clickable mailto link:
[[email protected]](mailto:[email protected])🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/onboarding-guide/upholding-code-of-conduct.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/onboarding-guide/upholding-code-of-conduct.md
47-47: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (1)
docs/onboarding-guide/upholding-code-of-conduct.md (1)
7-65: Well-structured guide—great work!This document clearly communicates contributor responsibilities, incident reporting steps, conflict resolution paths, and resources. Beyond the minor editorial tweaks above, everything looks solid.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Bare URL used
null(MD034, no-bare-urls)
|
/rtm |
4 participants
Description
Related issue(s)
#1622Summary by CodeRabbit