Skip to content

HYPERLFEET-760 - docs: align with documentation standard#95

Open
rh-amarin wants to merge 3 commits intoopenshift-hyperfleet:mainfrom
rh-amarin:add-changelog
Open

HYPERLFEET-760 - docs: align with documentation standard#95
rh-amarin wants to merge 3 commits intoopenshift-hyperfleet:mainfrom
rh-amarin:add-changelog

Conversation

@rh-amarin
Copy link
Copy Markdown
Contributor

@rh-amarin rh-amarin commented Mar 27, 2026

Adds missing files to align with documentation standard:

  • CHANGELOG.md
  • CONTRIBUTING.md

Summary by CodeRabbit

  • Documentation
    • Added CHANGELOG documenting project releases, version history, and categorized updates using Keep a Changelog format with Semantic Versioning.
    • Added CONTRIBUTING guide with instructions for local development setup, repository overview, testing procedures, commit message standards, and release workflow information.

rh-amarin and others added 3 commits March 27, 2026 12:07
Add comprehensive changelog documenting all notable changes to the project.
Follows the Keep a Changelog format and HyperFleet architecture standard.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add comprehensive changelog documenting all notable changes organized by
version (v0.1.0, v0.1.1, and unreleased). Follows the Keep a Changelog
format and HyperFleet architecture standard.

- Organized changes by semantic version based on upstream tags
- Updated PR links to reference openshift-hyperfleet organization
- Included version comparison links for traceability

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add comprehensive contributor guide covering development setup, repository
structure, testing workflows, and common development tasks. Follows the
HyperFleet architecture standard template.

Part of HYPERFLEET-761 - documentation standards compliance

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@openshift-ci openshift-ci bot requested review from 86254860 and ciaranRoche March 27, 2026 15:48
@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented Mar 27, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign rafabene for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

Walkthrough

Two new documentation files were added to the repository. CHANGELOG.md documents project releases using the "Keep a Changelog" format with Semantic Versioning, including entries for unreleased changes and historical versions (0.1.1 and 0.1.0) with categorized subsections. CONTRIBUTING.md provides comprehensive contribution guidelines covering local development setup, repository structure, testing procedures, build commands, commit message standards, and the semantic versioning-based release process.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title references alignment with documentation standards and adds CHANGELOG.md and CONTRIBUTING.md, which matches the changeset of adding documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (3)
CONTRIBUTING.md (2)

224-224: Add language specifier to the fenced code block.

The code block for the commit message example should specify a language (or use text for plain text) to ensure proper rendering across different markdown processors.

📝 Proposed fix
-```
+```text
 HYPERFLEET-123 - fix: handle nil pointer in status aggregation
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` at line 224, The fenced code block in CONTRIBUTING.md lacks
a language specifier; update the triple-backtick fence for the commit message
example to include a language (e.g., use ```text) so the commit message renders
correctly across markdown processors and viewers.

53-53: Add language specifier to the fenced code block.

The code block showing the directory structure should specify a language (or use text for plain text) to ensure proper rendering across different markdown processors.

📝 Proposed fix
-```
+```text
 hyperfleet-api/
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` at line 53, The fenced code block that shows the directory
structure (the block containing "hyperfleet-api/") lacks a language specifier;
update that opening fence to include a language (e.g., change ``` to ```text) so
the snippet renders correctly across markdown processors, leaving the content
unchanged.
CHANGELOG.md (1)

138-139: Remove the empty Security subsection.

The Security subsection is present but contains no entries. Per Keep a Changelog conventions, empty subsections should be omitted entirely to avoid confusion. Only include subsections when there are relevant changes to document.

📝 Proposed fix to remove empty subsection
-### Security
-
 [Unreleased]: https://github.com/openshift-hyperfleet/hyperfleet-api/compare/v0.1.1...HEAD
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` around lines 138 - 139, Remove the empty "### Security"
subsection from CHANGELOG.md: delete the header line "### Security" (and any
following blank line) so that no empty subsection remains, and scan the file for
any other empty subsection headers to remove similarly to keep the changelog
conformant with Keep a Changelog conventions.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CHANGELOG.md`:
- Around line 138-139: Remove the empty "### Security" subsection from
CHANGELOG.md: delete the header line "### Security" (and any following blank
line) so that no empty subsection remains, and scan the file for any other empty
subsection headers to remove similarly to keep the changelog conformant with
Keep a Changelog conventions.

In `@CONTRIBUTING.md`:
- Line 224: The fenced code block in CONTRIBUTING.md lacks a language specifier;
update the triple-backtick fence for the commit message example to include a
language (e.g., use ```text) so the commit message renders correctly across
markdown processors and viewers.
- Line 53: The fenced code block that shows the directory structure (the block
containing "hyperfleet-api/") lacks a language specifier; update that opening
fence to include a language (e.g., change ``` to ```text) so the snippet renders
correctly across markdown processors, leaving the content unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 122a1aae-dc78-4404-89c6-68105d1d609f

📥 Commits

Reviewing files that changed from the base of the PR and between d63c4d7 and 30382ca.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • CONTRIBUTING.md

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