Update Code of Conduct attribution to Contributor Covenant v2.1 #758
Conversation
Updates the Code of Conduct attribution to Contributor Covenant v2.1 and makes minor wording improvements for clarity and inclusivity
WalkthroughThe CODE_OF_CONDUCT.md was revised: the pledge wording was broadened to reference "members, contributors, and leaders" and explicitly includes visible or invisible disability, sex characteristics, socio‑economic status, caste, and color, plus a new sentence committing to an open, welcoming, diverse, inclusive, and healthy community. Enforcement contact was changed to "community leaders responsible for enforcement" and now states complaints will be reviewed and investigated promptly and fairly; confidentiality language was generalized. Attribution was updated to note adaptation from Contributor Covenant v2.1 with the corresponding URL. Lines changed: +8/-7. 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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: 2
🤖 Fix all issues with AI agents
In `@CODE_OF_CONDUCT.md`:
- Around line 43-45: Remove the duplicate markdown header by deleting the extra
"## Attribution" occurrence so only one "## Attribution" header remains; locate
the repeated header text "## Attribution" in the file and remove the second
instance, leaving the rest of the document content unchanged.
- Around line 47-51: Remove the unused reference label "[version]" from
CODE_OF_CONDUCT.md and replace the bare URL
"https://www.contributor-covenant.org/version/2/1/code_of_conduct.html" with a
reference-style link (e.g., add a new reference like [code_of_conduct]:
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html and use
that reference in the body) so the document uses consistent reference-style
links and no unused reference labels remain.
🧹 Nitpick comments (1)
CODE_OF_CONDUCT.md (1)
37-39: Consider minor wording improvements for clarity.The enforcement section updates look good overall. Consider these optional refinements:
- Line 37: "project-designated" (with hyphen) is more grammatically correct than "project designated"
- Line 39: "regarding" is more concise than "with regard to"
📝 Optional wording improvements
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at a project designated contact address. All complaints will be reviewed and investigated promptly and fairly. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at a project-designated contact address. All complaints will be reviewed and investigated promptly and fairly. -The project team is committed to maintaining confidentiality with regard to the reporter of an incident, consistent with the need to investigate and address the reported behavior. +The project team is committed to maintaining confidentiality regarding the reporter of an incident, consistent with the need to investigate and address the reported behavior.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@CODE_OF_CONDUCT.md`:
- Line 5: The sentence "we as contributors and maintainers pledge to making
participation in our project and community a harassment-free experience..." is
ungrammatical; update the phrase "pledge to making" to "pledge to make" so it
reads "we as contributors and maintainers pledge to make participation in our
project and community a harassment-free experience for everyone..." — locate
that sentence (the one beginning "In the interest of fostering an open and
welcoming environment...") and replace the verb phrase accordingly.
🧹 Nitpick comments (1)
CODE_OF_CONDUCT.md (1)
37-39: Minor style: hyphenate and tighten wording.
Optional clarity polish.✏️ Proposed fix
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at a project designated contact address. All complaints will be reviewed and investigated promptly and fairly. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at a project-designated contact address. All complaints will be reviewed and investigated promptly and fairly. -The project team is committed to maintaining confidentiality with regard to the reporter of an incident, consistent with the need to investigate and address the reported behavior. +The project team is committed to maintaining confidentiality regarding the reporter of an incident, consistent with the need to investigate and address the reported behavior.
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@CODE_OF_CONDUCT.md`:
- Around line 45-47: Replace the existing attribution line "This Code of Conduct
is adapted from the [Contributor Covenant][homepage], version 2.1." and the
corresponding [homepage] link with the official recommended attribution text and
URL: use "This Code of Conduct is adapted from the Contributor Covenant, version
2.1, available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html" and
update the [homepage] reference (if still used) to point to the .html URL so the
document matches the Contributor Covenant v2.1 official format.
- Around line 37-39: Replace the current enforcement section text with the exact
Contributor Covenant v2.1 enforcement wording: use "community leaders
responsible for enforcement at [INSERT CONTACT METHOD]" (replace current
"project maintainers" and "project designated contact address"), hyphenate
"project-designated" where used, and use the official privacy sentence "All
community leaders are obligated to respect the privacy and security of the
reporter of any incident." Ensure the replaced block exactly matches the CC v2.1
enforcement section wording.
- Line 5: The Code of Conduct pledge in CODE_OF_CONDUCT.md does not match
Contributor Covenant v2.1 despite the attribution; either replace the current
pledge paragraph and opening sentence with the exact official v2.1 text
(including the missing second pledge sentence and all protected categories such
as visible/invisible disability, sex characteristics, education, socio-economic
status, caste, color) or change the attribution line that claims v2.1 to
correctly reflect the actual version/derivation; update the opening phrase to
the official "We as members, contributors, and leaders" if adopting v2.1 and
ensure the entire document matches the official v2.1 wording exactly if you keep
that attribution.
CODE_OF_CONDUCT.md
Outdated
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at a project designated contact address. All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| The project team is committed to maintaining confidentiality with regard to the reporter of an incident, consistent with the need to investigate and address the reported behavior. |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Contributor Covenant version 2.1 enforcement section official text
💡 Result:
The official "Enforcement" section for Contributor Covenant v2.1 states (paraphrased):
- Reports of abusive, harassing, or unacceptable behavior should be sent to the community leaders at the project's specified contact method.
- Complaints will be reviewed and investigated promptly and fairly.
- Community leaders must respect the reporter’s privacy and security.
For the exact official wording, see the Contributor Covenant v2.1 page. [1]
Reference:
[1] Contributor Covenant — Version 2.1, Code of Conduct (Enforcement section). https://www.contributor-covenant.org/version/2/1/code_of_conduct/
🏁 Script executed:
# Let's also check if there are any other references to hyphenation rules for "project designated"
rg "project.designated" --type md -iRepository: CircuitVerse/Interactive-Book
Length of output: 324
🌐 Web query:
Contributor Covenant 2.1 complete enforcement section exact wording community leaders
💡 Result:
Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. [1]
Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident. [1]
Source: Contributor Covenant version 2.1 (official text). [1]
🏁 Script executed:
# Check the full context of lines around 37-39 in the file to see the complete enforcement section
cat -n CODE_OF_CONDUCT.md | sed -n '30,45p'Repository: CircuitVerse/Interactive-Book
Length of output: 1368
Replace enforcement section to match Contributor Covenant v2.1; fix hyphenation.
The enforcement section (lines 37-39) deviates significantly from the official Contributor Covenant v2.1 text. Since the file attributes itself to CC v2.1, the enforcement section should match the official wording exactly. Key differences:
-
Line 37: Uses "project maintainers" and "project designated contact address" instead of the official "community leaders responsible for enforcement at [INSERT CONTACT METHOD]"—and "project designated" should be hyphenated as "project-designated" (compound adjective).
-
Line 39: The privacy language differs from the official text. CC v2.1 states "All community leaders are obligated to respect the privacy and security of the reporter of any incident," but the current text adds different phrasing about investigating and addressing behavior.
Replace with the official CC v2.1 enforcement section to ensure consistency with the claimed source attribution.
🧰 Tools
🪛 LanguageTool
[grammar] ~37-~37: Use a hyphen to join words.
Context: ...ing the project maintainers at a project designated contact address. All complain...
(QB_NEW_EN_HYPHEN)
[style] ~39-~39: ‘with regard to’ might be wordy. Consider a shorter alternative.
Context: ...ommitted to maintaining confidentiality with regard to the reporter of an incident, consistent...
(EN_WORDINESS_PREMIUM_WITH_REGARD_TO)
🤖 Prompt for AI Agents
In `@CODE_OF_CONDUCT.md` around lines 37 - 39, Replace the current enforcement
section text with the exact Contributor Covenant v2.1 enforcement wording: use
"community leaders responsible for enforcement at [INSERT CONTACT METHOD]"
(replace current "project maintainers" and "project designated contact
address"), hyphenate "project-designated" where used, and use the official
privacy sentence "All community leaders are obligated to respect the privacy and
security of the reporter of any incident." Ensure the replaced block exactly
matches the CC v2.1 enforcement section wording.
1 participant
Updates the Code of Conduct attribution to Contributor Covenant v2.1 and makes minor wording improvements for clarity and inclusivity
A meaningful title for PR, not like: made changes to xyz.md
Changes done:
Screenshots: Not applicable (documentation only change)
Preview Link(s): Not applicable (documentation only change)
✅️ By submitting this PR, I have verified the following
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.