Skip to content

chore: create CODE_OF_CONDUCT.md #274

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 1 commit into from
May 12, 2025
Merged

Conversation

pottekkat
Copy link
Collaborator

@pottekkat pottekkat commented May 12, 2025

Added a code of conduct.

From: https://www.contributor-covenant.org/

Mentions the Discord server as the platform to address concerns but this can be changed to an email address or mailing list if we have one.

Copy link
Contributor

coderabbitai bot commented May 12, 2025

Walkthrough

A new file, CODE_OF_CONDUCT.md, has been added to the repository. This file contains the Contributor Covenant Code of Conduct version 2.0, outlining expected standards of behavior, enforcement guidelines, reporting procedures, and attribution.

Changes

File(s) Change Summary
CODE_OF_CONDUCT.md Added new file with the Contributor Covenant Code of Conduct v2.0, including standards, enforcement, and credits.

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (2)
CODE_OF_CONDUCT.md (2)

28-38: Refine wording for stronger clarity.

At line 32, the phrase “Trolling, insulting or derogatory comments, and personal or political attacks” is accurate but can be tightened for impact. For example:

-* Trolling, insulting or derogatory comments, and personal or political attacks
+* Trolling, insults, derogatory language, or personal/political attacks

This small tweak breaks out each negative behavior for quicker scanning.

🧰 Tools
🪛 LanguageTool

[style] ~32-~32: Try using a synonym here to strengthen your wording.
Context: ...ind * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...

(COMMENT_REMARK)


115-129: Convert bare URLs to inline links and fix minor determiners.

Markdown lint flags bare URLs at lines 119, 127, and 128. Additionally, line 121 should begin with “The Community Impact Guidelines…” for grammatical consistency. Suggested diff:

@@ line 119
- version 2.0, available at
- https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+ version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html].
@@ line 121
- Community Impact Guidelines were inspired by [Mozilla's code of conduct
- enforcement ladder](https://github.com/mozilla/diversity).
+ The Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
@@ line 127
- For answers to common questions about this code of conduct, see the FAQ at
- https://www.contributor-covenant.org/faq. Translations are available at
- https://www.contributor-covenant.org/translations.
+ For answers to common questions about this code of conduct, see the [FAQ](https://www.contributor-covenant.org/faq).  
+ Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

These changes eliminate bare URLs and improve grammatical flow.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~120-~120: You might be missing the article “the” here.
Context: ....org/version/2/0/code_of_conduct.html. Community Impact Guidelines were inspired by [Moz...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)

119-119: Bare URL used
null

(MD034, no-bare-urls)


127-127: Bare URL used
null

(MD034, no-bare-urls)


128-128: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e5121b3 and 5db2776.

📒 Files selected for processing (1)
  • CODE_OF_CONDUCT.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
CODE_OF_CONDUCT.md

[style] ~32-~32: Try using a synonym here to strengthen your wording.
Context: ...ind * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...

(COMMENT_REMARK)


[uncategorized] ~120-~120: You might be missing the article “the” here.
Context: ....org/version/2/0/code_of_conduct.html. Community Impact Guidelines were inspired by [Moz...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)
CODE_OF_CONDUCT.md

119-119: Bare URL used
null

(MD034, no-bare-urls)


127-127: Bare URL used
null

(MD034, no-bare-urls)


128-128: Bare URL used
null

(MD034, no-bare-urls)

🔇 Additional comments (4)
CODE_OF_CONDUCT.md (4)

15-27: Standards section is clear and comprehensive.

The bullet list under “## Our Standards” effectively captures positive behaviors. No changes needed here; this aligns well with Contributor Covenant guidance.


51-58: Scope section is well-defined.

Good coverage of where and when this Code of Conduct applies. Clear and concise.


59-67: Reporting instructions look solid.

Linking to the Discord server is appropriate. Confirm that the invite URL won’t expire, or consider adding an email fallback for reporters without Discord access.

Could you verify that the Discord invite link is permanent and that an alternate reporting channel (like an email) is available if needed?


69-114: Enforcement guidelines follow standard best practices.

The four-level ladder (Correction → Warning → Temporary Ban → Permanent Ban) aligns with Mozilla’s model and Contributor Covenant recommendations. No changes required here.

Copy link
Collaborator

@rwjblue-glean rwjblue-glean left a comment

Choose a reason for hiding this comment

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

Looks good to me! I'll leave it to @ezynda3 to review as well before merging...

@pottekkat pottekkat requested a review from ezynda3 May 12, 2025 16:32
@pottekkat
Copy link
Collaborator Author

Thank you @robert-jackson-glean for the review. Yes, let's wait before merging.

@ezynda3 ezynda3 merged commit 20b3cb6 into mark3labs:main May 12, 2025
3 checks passed
@coderabbitai coderabbitai bot mentioned this pull request May 13, 2025
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants