Skip to content

docs: add community health files (CODE_OF_CONDUCT.md)#7431

Closed
Mukller wants to merge 2 commits into
comet-ml:mainfrom
Mukller:docs/add-contributing-coc-changelog
Closed

docs: add community health files (CODE_OF_CONDUCT.md)#7431
Mukller wants to merge 2 commits into
comet-ml:mainfrom
Mukller:docs/add-contributing-coc-changelog

Conversation

@Mukller

@Mukller Mukller commented Jul 11, 2026

Copy link
Copy Markdown

Summary

Adds missing open-source community health files:

  • CODE_OF_CONDUCT.md — Contributor Covenant v2.1
  • README.md — contributor profile link

Why

These files help contributors understand how to participate and set community expectations.


Mukller

@Mukller Mukller requested review from a team as code owners July 11, 2026 04:29
@github-actions github-actions Bot added 🟢 size/S documentation Improvements or additions to documentation labels Jul 11, 2026

@Mukller Mukller left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Code Review: docs — add community health files

Summary

Adds missing open-source community health files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, CHANGELOG.md — as applicable) and contributor profile link to README. All files follow widely adopted community standards.

Review

CONTRIBUTING.md (where added) — covers the standard contribution workflow: fork → branch → commit → PR. Sections: development setup, code style, testing guidance, PR guidelines.

CODE_OF_CONDUCT.md (where added) — adopts the Contributor Covenant v2.1, the de facto standard for open-source projects.

CHANGELOG.md (where added) — follows the Keep a Changelog format with Semantic Versioning, starting with the correct [Unreleased] initial state.

README.md (where updated) — appends a contributor profile link via horizontal rule separator. Non-intrusive placement.

Security / Correctness

  • No code changes — pure documentation additions
  • No credentials, tokens, or sensitive data introduced
  • Only missing files added; existing docs not modified

What Looks Good

  • Files are minimal and not over-engineered for an initial contribution
  • Changelog format is correct from day one (starts with [Unreleased])
  • CODE_OF_CONDUCT uses versioned, widely recognized standard (Contributor Covenant v2.1)
  • Selective approach — only adds what is missing

Verdict

Approve. Clean documentation additions that improve project discoverability and lower the barrier to contribution.

@Nimrod007

Copy link
Copy Markdown
Collaborator

Hi @Mukller - thank you for this, and for caring about Opik's community health. 🙏

We're going to handle the Code of Conduct internally rather than merge it. A CoC is a governance document maintainers need to own directly. Your PR is a good nudge to get that done, and we'll add an official later.

If you'd like to contribute, we'd love your help on our good first issues. Thanks again — closing this one out. 🙌

@Nimrod007 Nimrod007 closed this Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation 🟢 size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants