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

[Feature]: implement PR title checker workflow for conventional commit prefixes #667

Closed
7 tasks done
harmeetsingh11 opened this issue May 31, 2024 · 2 comments · Fixed by #723
Closed
7 tasks done
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request gssoc level1

Comments

@harmeetsingh11
Copy link
Contributor

harmeetsingh11 commented May 31, 2024

Description:

The project would benefit from a PR title checker that ensures conformity to conventional commit prefixes. Currently, the following prefixes are considered valid:

  • build:
  • chore:
  • docs:
  • feat:
  • fix:
  • perf:
  • refactor:
  • revert:
  • style:
  • test:

Problem:

Enforcing consistent and descriptive PR titles following conventional commit prefixes helps maintain clarity and organization in the project's version history.

Describe the solution you'd like

Implement a PR title checker that validates each PR title against the specified conventional commit prefixes. This will ensure that PR titles adhere to the established guidelines.

To-Do:

  • Develop the PR title checker script to verify titles against the defined prefixes.
  • Integrate the checker into the project's CI/CD pipeline.
  • Define error messages or warnings for non-compliant PR titles.

Screenshots

No response

Checklist

  • I have checked the existing issues
  • I have read the Contributing Guidelines
  • I am willing to work on this issue
  • I am a GSSoC'24 contributor
@harmeetsingh11 harmeetsingh11 added the enhancement New feature or request label May 31, 2024
Copy link

Hi @harmeetsingh11! Thanks for opening this issue. We appreciate your contribution to this open-source project.

@apu52 apu52 added documentation Improvements or additions to documentation gssoc labels Jun 2, 2024
@apu52
Copy link
Owner

apu52 commented Jun 2, 2024

@harmeetsingh11 you are assigned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request gssoc level1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants