search

shelcia / api-docucraft

https://api-docucraft.vercel.app
3 stars 8 forks source link

feat: add pr title checker workflow #22

Closed harmeetsingh11 closed 8 months ago

harmeetsingh11 commented 8 months ago

Issue:

This PR resolves issue #19

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

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:

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.

@shelcia please review this PR. Thanks

vercel[bot] commented 8 months ago

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

Name Status Preview Comments Updated (UTC)
api-docucraft ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 24, 2024 4:53pm