docs: add community health files and README updates - #1966
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds standard community files, including CHANGELOG.md, CODE_OF_CONDUCT.md, and CONTRIBUTING.md, and appends a personal signature to the README.md. The reviewer feedback recommends removing the personal signature blocks across all files since Git history already tracks contributions. Additionally, the reviewer suggests providing a specific contact method for reporting incidents in the Code of Conduct and advises redirecting or aligning the new CONTRIBUTING.md with the existing official online contributing guide to prevent duplication.
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.
| --- | ||
|
|
||
| *[Mukller](https://github.com/Mukller)* |
There was a problem hiding this comment.
Adding a personal signature or profile link to the bottom of the main README.md is not standard practice for shared open-source projects (especially under an organization like keras-team). Git history automatically tracks and credits all contributors. Please remove this signature block from the README.md as well as from the other community files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, CHANGELOG.md).
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers. |
There was a problem hiding this comment.
A Code of Conduct needs a clear, actionable contact method (such as an email address or a link to a reporting form) so that community members know how and where to report incidents. Please update this section to include a specific contact address.
| 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]. |
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing! |
There was a problem hiding this comment.
The project already has an official, detailed Contributing Guide hosted at https://autokeras.com/contributing/ (as referenced in the README.md). Adding a separate, simplified CONTRIBUTING.md file can lead to duplication and inconsistency. It is recommended to either have CONTRIBUTING.md simply point/redirect to the official online guide, or ensure that the content here is fully synchronized and does not conflict with the existing guide.
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) 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.
1 participant
Summary
Adds missing open-source community health files:
Why
These files help contributors understand how to participate and set community expectations.
Mukller