Skip to content

docs: add community health files (CODE_OF_CONDUCT.md, CHANGELOG.md)#557

Open
Mukller wants to merge 3 commits into
shenweichen:masterfrom
Mukller:docs/add-contributing-coc-changelog
Open

docs: add community health files (CODE_OF_CONDUCT.md, CHANGELOG.md)#557
Mukller wants to merge 3 commits into
shenweichen:masterfrom
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
  • CHANGELOG.md — Keep a Changelog format, Semantic Versioning
  • README.md — contributor profile link

Why

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


Mukller

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@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.

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