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.

Sign up for GitHub

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

Jump to bottom

[feature]: implement PR title checker workflow for conventional commit prefixes #883

Closed
4 of 7 tasks
harmeetsingh11 opened this issue Jan 30, 2025 · 1 comment · Fixed by #889
Closed
4 of 7 tasks

[feature]: implement PR title checker workflow for conventional commit prefixes #883

harmeetsingh11 opened this issue Jan 30, 2025 · 1 comment · Fixed by #889
Assignees
@harmeetsingh11
Labels
bug Something isn't working enhancement New feature or request WoC 4.0 Open Source Label

Comments

@harmeetsingh11
Copy link
Collaborator

Is there an existing feature request for this?

  • I have searched the existing issues

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.

Solution:

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.

Priority/Impact

Medium

Checklist

  • I have read the Contributing Guidelines
  • I am willing to work on this issue
  • I am a WOC 4.0 contributor
@github-actions github-actions bot added the SWOC label Jan 30, 2025
@github-actions GitHub Actions
Copy link

Hi there! Thanks for opening this issue @harmeetsingh11!. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.If belong's to SWOC program role ur self as Contributor in OS lead site Link : https://www.oslead.xyz/usertype , so that ur points will be assigned to the leaderboard. New to Open Source Contribution check out the below YT video , Happy Coding🚀💻🐛 🔗 Link : https://www.youtube.com/watch?v=3afUKB3guZA

@github-actions github-actions bot added enhancement New feature or request bug Something isn't working labels Jan 30, 2025
@Anjaliavv51 Anjaliavv51 added WoC 4.0 Open Source Label and removed SWOC labels Feb 2, 2025
@harmeetsingh11 harmeetsingh11 mentioned this issue Feb 4, 2025
Merged
8 tasks
Anjaliavv51 added a commit that referenced this issue Feb 13, 2025
@Anjaliavv51
feat: implement PR title checker workflow for conventional commit pre…
4509091 
…fixes (#889)

## Related Issues
- Closes #883 

## 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:
- [x] Develop and test the PR title checker script.
- [x] Integrate the checker into the CI/CD pipeline.
- [x] 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
<!-- [X] - put a cross/X inside [] to check the box -->
- [X] I have gone through the [contributing
guide](https://github.com/Anjaliavv51/Retro)
- [X] I have updated my branch and synced it with project `main` branch
before making this PR
- [X] I have performed a self-review of my code
- [X] I have tested the changes thoroughly before submitting this pull
request.
- [X] I have provided relevant issue numbers, screenshots, and videos
after making the changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@harmeetsingh11 harmeetsingh11

Labels
bug Something isn't working enhancement New feature or request WoC 4.0 Open Source Label
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: implement PR title checker workflow for conventional commit prefixes harmeetsingh11/Retro
2 participants
@harmeetsingh11 @Anjaliavv51