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

Add PR title check workflow #12337

Closed
wants to merge 2 commits into from
Closed

Add PR title check workflow #12337

wants to merge 2 commits into from

Conversation

rjan90
Copy link
Contributor

@rjan90 rjan90 commented Aug 5, 2024

Related Issues

Closes: #12148

Proposed Changes

A GitHub Actions workflow to automatically check and enforce a consistent format for PR titles.

Key features of the PR title check workflow:

Checklist

Before you mark the PR ready for review, please make sure that:

  • Commits have a clear commit message.
  • PR title is in the form of of <PR type>: <area>: <change being made>
    • example: fix: mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
    • area, e.g. api, chain, state, mempool, multisig, networking, paych, proving, sealing, wallet, deps
  • Update CHANGELOG.md or signal that this change does not need it.
    • If the PR affects users (e.g., new feature, bug fix, system requirements change), update the CHANGELOG.md and add details to the UNRELEASED section.
    • If the change does not require a CHANGELOG.md entry, do one of the following:
      • Add [skip changelog] to the PR title
      • Add the label skip/changelog to the PR
  • New features have usage guidelines and / or documentation updates in
  • Tests exist for new functionality or change in behavior
  • CI is green

Add PR title check workflow
Add colon
Copy link

github-actions bot commented Aug 5, 2024

Your PR title does not match the required format. Please update it to follow this convention: <type>: <scope>: <subject>

Types: feat, fix, docs, style, refactor, test, chore
Scope: required
Subject: start with lowercase

@github-actions github-actions bot closed this Aug 5, 2024
@rjan90
Copy link
Contributor Author

rjan90 commented Aug 5, 2024

Maybe a little too aggressive closing the PR if it does not conform to the title standards. Will adjust😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DX Streamline] Add mechanism so PR titles conform to repo standard
1 participant