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

Feat: PR Title Validation #2159

Open
sanmarg opened this issue May 17, 2024 · 0 comments · May be fixed by #2170
Open

Feat: PR Title Validation #2159

sanmarg opened this issue May 17, 2024 · 0 comments · May be fixed by #2170
Labels
help wanted Need some extra hands to get this done. status/ready Issue ready to be worked on. type/chore Issue that requests non-user facing changes.

Comments

@sanmarg
Copy link

sanmarg commented May 17, 2024

The purpose of this issue is to ensure that all pull requests (PRs) submitted to our repository follow a consistent and meaningful naming convention. This will improve the readability and maintainability of our project by making it easier to understand the purpose of each PR at a glance. I came across this project and was exploring it and had difficulty in understanding the PR's at glance So I wish to add this. Below is more information for it.

Problem:

Currently, there is no standardized format for PR titles in our repository. This can lead to confusion and difficulty in understanding the intent and scope of changes introduced by each PR. Inconsistent PR titles also make it harder to generate meaningful release notes and track changes over time.

Solution:

To address this issue, we will implement a GitHub Action that automatically checks the titles of PRs against a predefined format. This action will ensure that PR titles follow a specific pattern, making them more informative and standardized.

@sanmarg sanmarg added status/triage Issue or PR that requires contributor attention. type/enhancement Issue that requests a new feature or improvement. labels May 17, 2024
@jjbustamante jjbustamante added type/chore Issue that requests non-user facing changes. status/ready Issue ready to be worked on. and removed status/triage Issue or PR that requires contributor attention. type/enhancement Issue that requests a new feature or improvement. labels May 20, 2024
@sanmarg sanmarg linked a pull request May 29, 2024 that will close this issue
@natalieparellano natalieparellano linked a pull request Jul 1, 2024 that will close this issue
@natalieparellano natalieparellano added the help wanted Need some extra hands to get this done. label Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Need some extra hands to get this done. status/ready Issue ready to be worked on. type/chore Issue that requests non-user facing changes.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants