Skip to content

Conversation

@ezr-ondrej
Copy link
Member

@ezr-ondrej ezr-ondrej commented Nov 13, 2025

Overview

This PR is proposing validation of commit massages to start conforming to common style.
It describes the proposed style in the CONTRIBUTING.md

Summary by Sourcery

Enforce a standardized commit message style by adding validation in CI and documenting the Angular Conventional Commits format

New Features:

  • Add automated commit message validation to the CI workflow

CI:

  • Integrate host_inventory_changelog commit-check into GitHub Actions checks

Documentation:

  • Introduce Angular Conventional Commits guidelines in CONTRIBUTING.md with format, types, scope, examples, and best practices

Adds commit validation and documents the required commit message style.
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 13, 2025

Reviewer's Guide

This PR integrates automated commit message validation into the CI pipeline and adds detailed commit style guidelines to the CONTRIBUTING documentation.

File-Level Changes

Change Details Files
Add commit message validation step in CI workflow
  • Introduce a secondary checkout for the changelog repository
  • Install the host_inventory_changelog package
  • Invoke the commit-check command against the PR head
.github/workflows/checks.yaml
Document Angular Conventional Commits style in CONTRIBUTING
  • Define commit message format, types, and required ticket scope
  • Provide examples for common commit types
  • Outline subject line guidelines and mandatory conventions
CONTRIBUTING.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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