docs: add community health files (CODE_OF_CONDUCT.md, CHANGELOG.md) - #726
docs: add community health files (CODE_OF_CONDUCT.md, CHANGELOG.md)#726Mukller wants to merge 3 commits into
Conversation
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis pull request adds repository documentation for releases and contributor guidance: a changelog template, a code of conduct file, and a README contributing section linking to those documents. ChangesRepository documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CODE_OF_CONDUCT.md (1)
1-68: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winReformat this markdown before merge.
CODE_OF_CONDUCT.mdis currently failing the repo's Prettier check, so the lint job will stay red until the file is rewritten in the project’s markdown format.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CODE_OF_CONDUCT.md` around lines 1 - 68, `CODE_OF_CONDUCT.md` needs to be rewritten to match the repository’s Prettier markdown style. Reformat the existing content so headings, lists, line wrapping, and link/reference definitions conform to the project’s markdown formatting rules, while preserving the current wording and structure of the Contributor Covenant sections.Source: Pipeline failures
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CHANGELOG.md`:
- Around line 1-36: The release body currently includes changelog guidance and
contributor attribution, which will be published because CHANGELOG.md is used as
the GitHub release body file. Remove the “How to Update This Changelog” section
and the author attribution from the release-facing content, keeping only the
actual changelog entries under Unreleased in CHANGELOG.md so the body stays
clean; this should be updated in the same area that feeds
.github/workflows/publish_github.yml.
---
Outside diff comments:
In `@CODE_OF_CONDUCT.md`:
- Around line 1-68: `CODE_OF_CONDUCT.md` needs to be rewritten to match the
repository’s Prettier markdown style. Reformat the existing content so headings,
lists, line wrapping, and link/reference definitions conform to the project’s
markdown formatting rules, while preserving the current wording and structure of
the Contributor Covenant sections.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 435029f0-ca64-4887-8c40-81b828da2ed3
📒 Files selected for processing (2)
CHANGELOG.mdCODE_OF_CONDUCT.md
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
| - Future features and improvements will be listed here | ||
|
|
||
| ### Changed | ||
| - Ongoing updates and modifications | ||
|
|
||
| ### Fixed | ||
| - Bug fixes and corrections | ||
|
|
||
| --- | ||
|
|
||
| ## How to Update This Changelog | ||
|
|
||
| When making changes, add an entry under `[Unreleased]` in the appropriate category: | ||
|
|
||
| - **Added** – new features | ||
| - **Changed** – changes to existing functionality | ||
| - **Deprecated** – soon-to-be removed features | ||
| - **Removed** – removed features | ||
| - **Fixed** – bug fixes | ||
| - **Security** – vulnerability fixes | ||
|
|
||
| When releasing, change `[Unreleased]` to the version number and date, | ||
| then add a new empty `[Unreleased]` section at the top. | ||
|
|
||
| --- | ||
| *Documentation contributed by [Mukller](https://github.com/Mukller)* |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep the release body free of authoring notes.
CHANGELOG.md is used directly as bodyFile in .github/workflows/publish_github.yml, so the update instructions and contributor attribution at the bottom will be published in every release. That will clutter the release notes and make them less useful. Please keep the release-facing content separate from the guidance text. CI also already reports a Prettier failure on this file.
🧰 Tools
🪛 GitHub Actions: Lint on push or pull request / 0_lint.txt
[warning] 1-1: Prettier check failed for this file ([warn] CHANGELOG.md). Run 'prettier --write' (via 'pnpm run format') to fix formatting.
🪛 GitHub Actions: Lint on push or pull request / lint
[warning] 1-1: Prettier reported a formatting/style issue in CHANGELOG.md (format check failed). Run 'prettier --write' to fix.
🪛 LanguageTool
[grammar] ~27-~27: Use a hyphen to join words.
Context: ...ctionality - Deprecated – soon-to-be removed features - Removed – removed...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CHANGELOG.md` around lines 1 - 36, The release body currently includes
changelog guidance and contributor attribution, which will be published because
CHANGELOG.md is used as the GitHub release body file. Remove the “How to Update
This Changelog” section and the author attribution from the release-facing
content, keeping only the actual changelog entries under Unreleased in
CHANGELOG.md so the body stays clean; this should be updated in the same area
that feeds .github/workflows/publish_github.yml.
Source: Pipeline failures
|
This PR only adds community health documentation files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, CHANGELOG.md) and a Contributing section to the README — no code or package functionality changes. No version bump is needed, so no changeset is required. The bot warning can be safely ignored for this PR. |
Mukller
left a comment
Mukller
left a comment
There was a problem hiding this comment.
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) to improve contributor onboarding and project governance. All added files follow widely adopted community standards.
Review
CONTRIBUTING.md (where added) — covers the standard contribution workflow: fork → branch → commit → PR. Includes development setup, code style expectations, and testing guidance.
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.
Security / Correctness
- No code changes — pure documentation additions
- No credentials, tokens, or sensitive data introduced
- Existing files were not modified (only missing files are added)
What Looks Good
- Each file is appropriately minimal and not over-engineered for an initial contribution
- The selective approach (only adding what's missing) avoids conflicts with existing community files
Verdict
Approve. Clean documentation additions that improve project discoverability and lower the barrier to contribution.
1 participant
Add Community Health Files
This PR adds the following community health files to
create-llama:What's included
CONTRIBUTING.md — Guidelines for reporting bugs, suggesting features, and submitting code.
CODE_OF_CONDUCT.md — Contributor Covenant 2.1, a widely-adopted standard for inclusive communities.
CHANGELOG.md — A structured template following Keep a Changelog format.
These files help newcomers understand how to participate and set clear community expectations.
Summary by CodeRabbit