Skip to content

docs: add community health files and README updates#10638

Open
Mukller wants to merge 4 commits into
hiyouga:mainfrom
Mukller:docs/add-contributing-coc-changelog
Open

docs: add community health files and README updates#10638
Mukller wants to merge 4 commits into
hiyouga: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:

  • CONTRIBUTING.md — contribution guidelines, development setup, PR process
  • 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

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request introduces standard community files including CHANGELOG.md, CODE_OF_CONDUCT.md, and CONTRIBUTING.md, and appends a signature to README.md. The reviewer's feedback focuses on removing the personal signature block from all of these files, as contributions are standardly tracked via Git history. Additionally, the reviewer suggests adding a contact method placeholder in the enforcement section of the Code of Conduct.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +968 to +970
---

*[Mukller](https://github.com/Mukller)*

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

It is standard practice in open-source repositories to avoid adding personal signatures or profile links to the main README.md or community health files. Contributions are automatically tracked by GitHub's contributors list and Git history. Please remove the personal signature block.

Comment thread CHANGELOG.md
Comment on lines +19 to +20
---
*[Mukller](https://github.com/Mukller)*

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Please remove the personal signature block from the changelog, as individual contributions are tracked via Git history rather than inline signatures.

Comment thread CODE_OF_CONDUCT.md
Comment on lines +29 to +30
---
*[Mukller](https://github.com/Mukller)*

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Please remove the personal signature block from the Code of Conduct, as individual contributions are tracked via Git history rather than inline signatures.

Comment thread CONTRIBUTING.md
Comment on lines +32 to +33
---
*[Mukller](https://github.com/Mukller)*

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Please remove the personal signature block from the contributing guidelines, as individual contributions are tracked via Git history rather than inline signatures.

Comment thread CODE_OF_CONDUCT.md

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The enforcement section mentions reporting to project maintainers but does not provide a contact method (such as an email address or a link to a reporting form). Please add a placeholder or a specific email address where violations can be reported.

Suggested change
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers at [INSERT EMAIL/CONTACT METHOD].

@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