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 #256

Open
4 of 7 tasks
harmeetsingh11 opened this issue Feb 22, 2024 · 1 comment
Open
4 of 7 tasks
Labels
enhancement Enhacing existing feature

Comments

@harmeetsingh11
Copy link
Contributor

harmeetsingh11 commented Feb 22, 2024

Is your feature request related to a problem? Please describe.

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 (optional)
  • I am a SWOC'24 contributor
@harmeetsingh11 harmeetsingh11 added the enhancement Enhacing existing feature label Feb 22, 2024
@ShwetKhatri2001
Copy link
Owner

Hey @harmeetsingh11 , will it not be difficult to understand for new contributors ? Also, if they don't create PRs with valid names, then reviewers need to spend extra time on validating that. What are your thoughts on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhacing existing feature
Projects
None yet
Development

No branches or pull requests

2 participants