docs(readme): add documentation to follow OSS standards#97
Merged
JustinZhang17 merged 10 commits intomainfrom Jun 30, 2025
Merged
docs(readme): add documentation to follow OSS standards#97JustinZhang17 merged 10 commits intomainfrom
JustinZhang17 merged 10 commits intomainfrom
Conversation
This changes adds a code of conduct, contributing guide, license, and restructures some of the project's readme
This change adds draft french translations, furthermore, the README.md is populated with details such as volume cleaner's features, requirements along with deepwiki and license badges.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds comprehensive OSS documentation, including contribution guidelines, security policy, code of conduct, and French translations to align with open-source standards
- Introduce
CONTRIBUTING.mdand enrichREADME.mdwith project overview, features, and Translations - Add
SECURITY.mdandCODE_OF_CONDUCT.mdwith English and French sections - Provide French translations across documentation
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| SECURITY.md | Added security reporting instructions in both English and French |
| README.md | Expanded introductory sections, features, quick start, and added French translation |
| CONTRIBUTING.md | Created detailed contribution guide with English and French versions |
| CODE_OF_CONDUCT.md | Added CNCF Code of Conduct reference and French translation |
Comments suppressed due to low confidence (3)
README.md:71
- The Quick Start section is currently empty; consider adding setup instructions or removing the placeholder to avoid confusion.
## Quick Start
README.md:95
- [nitpick] The French section does not include a link back to the English section. Consider adding an '(English)' link at the top for easier navigation.
# Volume Cleaner Kubernetes
SECURITY.md:1
- [nitpick] The anchor '#sécurité' may not resolve correctly due to the accented character. Consider using an ASCII-only anchor (e.g., '#securite') or verifying link rendering.
([Français](#sécurité))
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
5 tasks
anrayliu
requested changes
Jun 26, 2025
anrayliu
requested changes
Jun 27, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed Changes/Description
Types of Changes
What types of changes does your code introduce to volume-cleaner? Put an
xin the boxes that applyTesting
Look at
CONTRIBUTING.md,README.md,CODE_OF_CONDUCT.md, andSECURITY.mdScreenshots (if applicable)
N/A
Related Issue/Ticket
Closes #43
Checklist
Unit and/or integration tests added/modifiedLint and Unit tests pass locally with my changes