Skip to content
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.

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

feat: implement PR title checker workflow for conventional commit prefixes #889

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

harmeetsingh11
Copy link
Collaborator

@harmeetsingh11 harmeetsingh11 commented Feb 4, 2025

Related Issues

Description

This pull request addresses the need for a PR title checker to ensure conformity to conventional commit prefixes. The specified prefixes include build, chore, docs, feat, fix, perf, refactor, revert, style, and test. Consistent PR titles are essential for maintaining clarity and organization in the project's version history.

Files added

  • .github/pr-title-checker.json
  • .github/workflows/pr-title-checker.yml

Solution:

  1. Developed a PR title checker script to validate titles against the defined prefixes.
  2. Integrated the checker into the project's CI/CD pipeline for automatic validation.
  3. Defined clear error messages for non-compliant PR titles, aiding contributors in adhering to guidelines.

To-Do:

  • Develop and test the PR title checker script.
  • Integrate the checker into the CI/CD pipeline.
  • Define error messages for non-compliant PR titles.

This PR enhances the project's contribution guidelines by automating the validation of PR titles, ensuring adherence to conventional commit prefixes. Contributions and feedback are encouraged for continuous improvement.

Checklist

  • I have gone through the contributing guide
  • I have updated my branch and synced it with project main branch before making this PR
  • I have performed a self-review of my code
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers, screenshots, and videos after making the changes.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Great job, @harmeetsingh11! 🎉 Thank you for submitting your pull request. Your contribution is valuable and we appreciate your efforts to improve our project.We will promptly review your changes and offer feedback. Keep up the excellent work!

Copy link

netlify bot commented Feb 4, 2025

Deploy Preview for vintagevibe ready!

Name Link
🔨 Latest commit 4499c72
🔍 Latest deploy log https://app.netlify.com/sites/vintagevibe/deploys/67a2683b0590f700081c8d20
😎 Deploy Preview https://deploy-preview-889--vintagevibe.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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.

[feature]: implement PR title checker workflow for conventional commit prefixes
1 participant