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

chore: add validation for PR description and checklist #895

Closed
wants to merge 8 commits into from

Conversation

oCHRISo
Copy link
Collaborator

@oCHRISo oCHRISo commented Oct 9, 2024

Proposed changes

This PR adds validation to ensure that PRs adhere to the following requirements:

  1. The first two checklist items (related to reading the CONTRIBUTING document and running make install-tools) must be checked.
  2. The "Proposed changes" section must include a description with more than 10 words to provide adequate context about the changes being proposed.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • I have run make install-tools and have attached any dependency changes to this pull request
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • If applicable, I have updated any relevant documentation (README.md)
  • If applicable, I have tested my cross-platform changes on Ubuntu 22, Redhat 8, SUSE 15 and FreeBSD 13

@oCHRISo oCHRISo requested a review from a team as a code owner October 9, 2024 07:55
@oCHRISo oCHRISo added chore Pull requests for routine tasks v3.x Issues and Pull Requests related to the major version v3 labels Oct 9, 2024
@oCHRISo oCHRISo marked this pull request as draft October 9, 2024 08:33
@oCHRISo oCHRISo closed this Oct 9, 2024
@oCHRISo oCHRISo deleted the validate-pr-description-and-checklist branch October 9, 2024 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks v3.x Issues and Pull Requests related to the major version v3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants