Add workflow for checking PR titles & descriptions#1256
Open
mhucka wants to merge 1 commit intoquantumlib:mainfrom
Open
Add workflow for checking PR titles & descriptions#1256mhucka wants to merge 1 commit intoquantumlib:mainfrom
mhucka wants to merge 1 commit intoquantumlib:mainfrom
Conversation
This workflow adds very simple checks for minimum requirements: a title that has at least two words, and a description that is at least 10 characters long. In the future, more checks could be added as additional jobs in this workflow. For example, we should also check for the presence of non-inclusive terms such as "blacklist".
Contributor
|
Note Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This workflow adds very simple checks for minimum requirements: a title that has at least two words, and a description that is at least 10 characters long.
The goal is to block PRs that lack descriptions or have titles that are unlikely to be informative. A search of past PRs in this repo shows that this has happened in the past.
In the future, more checks could be added as additional jobs in this workflow. For example, we should also check for the presence of non-inclusive terms such as "blacklist".