Skip to content

This PR introduces a robust commit validation mechanism using commit-check-action and enhances the contribution guidelines for better developer experience and codebase hygiene. #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

This PR introduces a robust commit validation mechanism using commit-check-action and enhances the contribution guidelines for better developer experience and codebase hygiene. #38

wants to merge 1 commit into from

Conversation

smuppand
Copy link
Contributor

@smuppand smuppand commented May 19, 2025 •
edited
Loading

New Workflow:

  • Validates commit message structure, author identity, and sign-off using GitHub Actions.
  • Automatically comments on pull requests when violations are found.
  • Ensures commits to main are properly documented and signed.

Updated CONTRIBUTING.md:

  • Added commit message format examples.
  • Defined acceptable branch naming conventions.
  • Documented how to sign commits using --signoff.
  • Included troubleshooting tips for common CI failures.

Benefits:

  • Enforces consistent and traceable commits.
  • Reduces manual PR feedback and enforces standards automatically.
  • Improves auditability and aligns with industry open source contribution standards.
@mwasilew @craigez @nbobbaqcom

@smuppand
ci: add commit-check workflow and update contributing guidelines
8d85d6b 
- Introduced a new GitHub Actions workflow () that validates PR commit messages for:
  - Valid author name and email
- Configured the workflow to comment directly on pull requests when violations are found
- Updated CONTRIBUTING.md with new commit formatting rules, branch naming standards, and DCO requirements to help contributors adhere to best practices
- Ensures all commits to mainline meet traceability and compliance standards

Signed-off-by: Srikanth Muppandam <smuppand@qti.qualcomm.com>
@smuppand smuppand force-pushed the fix/kernel-tests branch from 8f7ebc3 to 8d85d6b Compare May 19, 2025 10:29
@smuppand smuppand marked this pull request as draft May 21, 2025 05:11
@mwasilew
Copy link
Contributor

The patch looks OK, but the resulting checks seem to be broken. Any idea what is wrong? Maybe there is a released version of this workflow that works?

@smuppand
Copy link
Contributor Author

New configuration at qualcomm-linux folder is available and recommendation is to use it, instead of maintaining it each repo.

@smuppand smuppand closed this May 29, 2025
@smuppand smuppand deleted the fix/kernel-tests branch June 6, 2025 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@smuppand @mwasilew