PR Helper-tool for optimized PR writing

Example

A developer submits a pull request with a title that reads, 'Fixed bug in user login.' PR Helper would suggest a more compliant version: `fix(login): resolve incorrect redirect after user login`.

Scenario

This function ensures that all commits adhere to Conventional Commits formatting, helping maintain consistency across a project. It automatically prompts the developer to use correct prefixes (e.g., 'fix', 'feat', 'docs'), ensuring that future code reviewers and maintainers can easily understand the nature of each commit.

Example

A developer describes their changes vaguely: 'Made some updates to the UI.' PR Helper would ask for more specific details, such as 'Which components were updated? Was it a bug fix or a feature enhancement?' Based on the clarification, it would refine the description to: `feat(UI): updated button style and alignment on the dashboard for improved UX`.

Scenario

This function helps avoid ambiguous or generic descriptions. Developers are guided to provide clear, actionable descriptions that future collaborators can easily understand. This increases productivity and reduces back-and-forth communication during code reviews.

Example

On a project where specific modules have predefined prefixes (e.g., `ui`, `api`, `auth`), PR Helper can be customized to enforce these prefixes in PR titles. If a developer submits a PR titled 'Added new endpoint,' it might suggest: `feat(api): add new user registration endpoint`.

Scenario

This allows projects to enforce their own conventions on top of general commitlint rules. Teams working in highly modular systems or with microservices architectures benefit from this, ensuring that every PR is tagged with the appropriate module or service prefix.