feat: add conventional commits PR title rule to CLAUDE.md#17
Merged
williambrady merged 1 commit intomainfrom Feb 24, 2026
Merged
feat: add conventional commits PR title rule to CLAUDE.md#17williambrady merged 1 commit intomainfrom
williambrady merged 1 commit intomainfrom
Conversation
Release-please requires PR titles to follow conventional commits format since GitHub uses the PR title as the squash merge commit message. Document this requirement to prevent silent release skips.
8db460a to
fb86cf6
Compare
🤖 Augment PR SummarySummary: Tightens contributor guidance and makes container image building an explicit opt-in while improving container scan robustness. Changes:
🤖 Was this summary useful? React with 👍 or 👎 |
There was a problem hiding this comment.
Pull request overview
This PR updates contributor/documentation guidance and refines container image scanning to be safer-by-default, while also introducing formatting/lint tooling and related refactors across scanner modules.
Changes:
- Document PR title requirements (Conventional Commits) and update repository guidance/docs (CLAUDE.md, README.md).
- Make Docker image building opt-in (default
build_images: false) with a new CLI flag and GitHub Action input to enable it when appropriate. - Add container-scanner unit tests and apply formatting/refactor cleanup across several scanners; introduce Black + pre-commit configuration.
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
CLAUDE.md |
Adds Conventional Commits PR-title rule and updates project guidance (including container build opt-in note). |
README.md |
Documents container image scanning usage, action input, and UNKNOWN→MEDIUM severity mapping note. |
action.yml |
Adds build-container-images input wiring for the GitHub Action. |
entrypoint.sh |
Plumbs new action input into CLI invocation via --build-container-images. |
src/main.py |
Adds --build-container-images CLI flag and overrides config to enable image building when set. |
src/config_loader.py |
Changes default container config to build_images: false. |
config/config.yaml |
Updates default container scanning config/comment to reflect opt-in image building. |
src/scanners/container_scanner.py |
Makes path handling explicit, sanitizes image prefix, avoids tag collisions, adds scan-failure finding. |
tests/test_container_scanner.py |
Adds unit tests for Dockerfile discovery, tag generation, parsing, and failure handling. |
tests/test_basic.py |
Adds RepoDetector tests for Dockerfile/variant detection. |
src/scanner_base.py |
Maps unknown severity strings to MEDIUM; minor formatting/refactor. |
src/scanners/terraform_scanner.py |
Formatting/refactor (single-line simplifications). |
src/scanners/cloudformation_scanner.py |
Formatting/refactor (single-line simplifications). |
src/scanners/python_scanner.py |
Formatting/refactor (single-line simplifications). |
src/scanners/npm_scanner.py |
Formatting/refactor (single-line simplifications). |
src/scanners/secrets_scanner.py |
Formatting/refactor (single-line simplifications). |
src/report_aggregator.py |
Formatting/refactor (single-line simplifications). |
src/repo_detector.py |
Formatting/refactor (single-line simplifications). |
src/formatters/sarif_formatter.py |
Formatting/refactor (single-line simplifications). |
src/formatters/markdown_formatter.py |
Formatting/refactor (single-line simplifications). |
pyproject.toml |
Adds Black configuration (line length 120, target py311). |
.pre-commit-config.yaml |
Adds pre-commit hooks for Black + Flake8 and general hygiene checks. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
feat,fix,docs,test,chore,refactor,ci) and their effect on versioningThis PR also serves to trigger release-please for the container scanning changes from PR #16 whose merge commit was not parseable.