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: add workflow for PR title checker #141

Conversation

harmeetsingh11
Copy link
Contributor

Issue:

This PR resolves issue #133

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

  • My code adheres to the established style guidelines of the project.
  • I have included comments in areas that may be difficult to understand.
  • My changes have not introduced any new warnings.
  • I have conducted a self-review of my code.

@JAYESHBATRA please review this PR.
Thanks

Copy link

vercel bot commented Jan 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
virtuo-learn ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 19, 2024 5:44pm

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 for Virtuo-Learn. Our dedicated team will review it diligently.Your contribution is valuable and we appreciate your efforts to improve our project.

@JAYESHBATRA JAYESHBATRA merged commit 51c0141 into JAYESHBATRA:main Jan 20, 2024
5 checks passed
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.

2 participants