Skip to content

Add Coc #355

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

Closed
wants to merge 1 commit into from
Closed

Add Coc #355

wants to merge 1 commit into from

Conversation

matmair
Copy link
Owner

@matmair matmair commented Apr 23, 2025

This adds the Contributor Covenant Code of Conduct as a code of conduct, as is best practice.

I recommend the Contributor Covenant Code of Conduct because it is proven in practice and has very gradual steps of enforcement as part of it - making rash changes less likely.
Due to the current size of the active devs I do not thunk we will need this any time soon.

See inventree#9525

Summary by CodeRabbit

  • Documentation
    • Added a Code of Conduct outlining community standards, reporting procedures, and enforcement guidelines to foster an inclusive and respectful environment.

@matmair matmair closed this Apr 23, 2025
Copy link

coderabbitai bot commented Apr 23, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

A new CODE_OF_CONDUCT.md file has been introduced to the repository. This document incorporates the Contributor Covenant Code of Conduct version 2.0, outlining behavioral expectations, standards for community interaction, enforcement responsibilities, and reporting procedures. It details the scope of the code, enforcement process, and possible consequences for violations, and provides references and credits for the adopted guidelines.

Changes

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

Poem

In the warren we gather, paws gentle and kind,
A covenant written, for all to remind.
With respect as our compass, and empathy our guide,
We burrow together, with no need to hide.
Let’s nibble on kindness, and hop without fear—
Our code keeps the meadow inclusive and clear! 🐇


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 021063d and 455b4b6.

📒 Files selected for processing (1)
  • CODE_OF_CONDUCT.md (1 hunks)

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.

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.

@matmair matmair deleted the add-CoC branch April 26, 2025 00:08
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.

1 participant