Skip to content

HYPERFLEET-882 - docs: add pre-commit hooks setup instructions#235

Merged
openshift-merge-bot[bot] merged 1 commit into
openshift-hyperfleet:mainfrom
rafabene:HYPERFLEET-882-add-pre-commit-hooks
Jul 9, 2026
Merged

HYPERFLEET-882 - docs: add pre-commit hooks setup instructions#235
openshift-merge-bot[bot] merged 1 commit into
openshift-hyperfleet:mainfrom
rafabene:HYPERFLEET-882-add-pre-commit-hooks

Conversation

@rafabene

@rafabene rafabene commented Jul 8, 2026

Copy link
Copy Markdown
Member

Summary

  • Add pre-commit to prerequisites in CONTRIBUTING.md
  • Add make install-hooks step in CONTRIBUTING.md setup instructions
  • Add pre-commit prerequisite note in README.md for developers
  • Add make install-hooks to development.md setup and Make Targets table

Pre-commit hooks (.pre-commit-config.yaml) and Makefile targets were already in place — this PR fills the documentation gap to match the pattern established in hyperfleet-sentinel (#102).

Test plan

  • Verify make install-hooks runs successfully
  • Verify pre-commit hooks trigger on commit

@openshift-ci openshift-ci Bot requested review from Mischulee and mbrudnoy July 8, 2026 19:27
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Documentation updates add pre-commit to local development prerequisites and add make install-hooks to setup instructions and the Make Targets table across CONTRIBUTING.md, README.md, and docs/development.md. CONTRIBUTING.md also states that hooks are configured in .pre-commit-config.yaml and run commit-message and code-quality checks.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 11
✅ Passed checks (11 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Sec-02: Secrets In Log Output ✅ Passed No non-test/example log calls interpolate or field-name token/password/credential/secret; only comments/docs and token-file errors. No CWE-532 leak.
No Hardcoded Secrets ✅ Passed Docs-only diff; no API keys/tokens/passwords/private keys, embedded-credential URLs, or long base64 blobs found. CWE-798 not triggered.
No Weak Cryptography ✅ Passed Docs-only diff; no banned crypto primitives, custom crypto, or secret comparisons found (CWE-327/CWE-328/CWE-208).
No Injection Vectors ✅ Passed Diff is docs-only; no SQL/exec/template/yaml-unmarshal patterns appear in the touched files, so CWE-89/78/79/502 are absent.
No Privileged Containers ✅ Passed PASS: PR only changes CONTRIBUTING.md, README.md, and docs/development.md; no K8s/OpenShift manifests, Helm templates, or Dockerfiles were modified.
No Pii Or Sensitive Data In Logs ✅ Passed PASS: HEAD only changes docs; no slog/logr/zap/fmt.Print logging statements or sensitive data exposure in the diff (CWE-532).
Title check ✅ Passed The title matches the docs-only pre-commit hook setup changes.
Description check ✅ Passed The description accurately reflects the documentation updates and test plan.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

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

@hyperfleet-ci-bot

Copy link
Copy Markdown

Risk Score: 0 — risk/low

Signal Detail Points
PR size 15 lines +0
Sensitive paths none +0

Computed by hyperfleet-risk-scorer

@rafabene rafabene force-pushed the HYPERFLEET-882-add-pre-commit-hooks branch from 61f4087 to 3bf6bb7 Compare July 8, 2026 19:36
@mliptak0

mliptak0 commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci

openshift-ci Bot commented Jul 9, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mliptak0

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

The pull request process is described 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

@openshift-ci openshift-ci Bot added the approved label Jul 9, 2026
@rafabene

rafabene commented Jul 9, 2026

Copy link
Copy Markdown
Member Author

/retest ci/prow/lint

@rafabene

rafabene commented Jul 9, 2026

Copy link
Copy Markdown
Member Author

/retest

@openshift-merge-bot openshift-merge-bot Bot merged commit 22dbdad into openshift-hyperfleet:main Jul 9, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants