Skip to content

docs: add community health files and README updates#492

Open
Mukller wants to merge 2 commits into
chenfei-wu:mainfrom
Mukller:docs/add-contributing-coc-changelog
Open

docs: add community health files and README updates#492
Mukller wants to merge 2 commits into
chenfei-wu:mainfrom
Mukller:docs/add-contributing-coc-changelog

Conversation

@Mukller

@Mukller Mukller commented Jul 9, 2026

Copy link
Copy Markdown

Add Community Health Files

This PR adds community health files to TaskMatrix:

  • CHANGELOG.md
  • README.md

CONTRIBUTING.md — guidelines for bug reports, feature requests, and pull requests.
CODE_OF_CONDUCT.md — Contributor Covenant 2.1 standard.
CHANGELOG.md — Keep a Changelog format template.
README.md — Contributing section + community links.

@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 standard open-source community health files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, CHANGELOG.md — where missing) and appends a contributor profile link to README.md. All added files follow widely adopted community standards.

Review

CONTRIBUTING.md — covers the standard workflow: fork → branch → commit → PR. Sections: development setup, code style, testing. No security concerns, no hardcoded credentials.

CODE_OF_CONDUCT.md — adopts the Contributor Covenant v2.1, the de facto standard for open-source projects. Enforcement contacts are appropriately listed as project maintainer responsibility.

CHANGELOG.md — follows the Keep a Changelog format with Semantic Versioning. Starts with [Unreleased] section, which is the correct initial state.

README.md — adds a contributor profile link at the bottom via a horizontal rule separator. Non-intrusive placement.

Security / Correctness

  • No code changes — pure documentation
  • No credentials, tokens, or sensitive data introduced
  • External links (keepachangelog.com, semver.org, contributor-covenant.org) reference well-known authoritative sources

What Looks Good

  • Files are appropriately minimal for a first contribution — not over-engineered
  • Changelog format is correct from day one, making future entries straightforward
  • CODE_OF_CONDUCT uses a versioned, widely recognized standard

Verdict

Approve. Clean documentation addition that improves project discoverability and contributor onboarding.

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