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 checks to improve repo history / change log #618

Closed
eddie-knight opened this issue Jan 11, 2025 · 2 comments · Fixed by #619
Closed

Add PR Title checks to improve repo history / change log #618

eddie-knight opened this issue Jan 11, 2025 · 2 comments · Fixed by #619
Assignees
Labels
community structure Work related to the Community Structure WG

Comments

@eddie-knight
Copy link
Contributor

Currently our repo history, and subsequently the release change logs, are full of a wild array of message styles.

We should create a status check that blocks merge until the PR title meets a certain standard.

Here are some ideas as a starting point...

where x is "features", "threats", "controls", "category", or "family":

  • add(x): <message>
  • change(x): <message>
  • remove(x): <message>

and for other changes:

  • ci: <message>
  • docs: <message>
@eddie-knight eddie-knight added the community structure Work related to the Community Structure WG label Jan 11, 2025
@jmeridth
Copy link
Contributor

I can snag this one and use one of my reusable workflows. PR inbound.

@jmeridth
Copy link
Contributor

Adhering to conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) I suggest the following types and scopes:

types

  • ci
  • docs
  • feat
  • fix

scopes

  • add
  • category
  • change
  • controls
  • family
  • remove
  • threats

jmeridth added a commit to jmeridth/common-cloud-controls that referenced this issue Jan 11, 2025
Closes finos#618

- [x] verify PR title is adhering to designed scopes and types

Signed-off-by: jmeridth <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community structure Work related to the Community Structure WG
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants