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(ci): add automation that asks/enforce PR title to incl. a workspace and change type #163

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

christoph-jerolimov
Copy link
Member

@christoph-jerolimov christoph-jerolimov commented Dec 12, 2024

Hey, I just made a Pull Request!

This PR adds the Conventional Commits convention to this repository, as we had already in backstage-showcase.

But here, with our workspaces, I set requireScope to true.

This will request that all PR titles starts with a type and a scope (workspace) like:

  • feat(bulk-import): awesome new feature
  • fix(repo-tools): some bugfixes
  • ...

All types:

  • feat
  • fix
  • chore
  • docs
  • style
  • refactor
  • perf
  • test
  • revert

It should ignore the Version PRs from @rhdh-bot

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or Updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)

@christoph-jerolimov
Copy link
Member Author

christoph-jerolimov commented Dec 12, 2024

/cc @BethGriggs @04kash @kim-tsao @schultzp2020

I'm not sure where is the right place to bring this up... So I raised a PR 😆

Wdyt? Any opinions?

If you're fine / not blocking this, then I would add a small section to CONTRIBUTING.md

@christoph-jerolimov christoph-jerolimov changed the title chore(ci): add automation that asks/enforce PR title to incl. a scope and change type chore(ci): add automation that asks/enforce PR title to incl. a workspace and change type Dec 12, 2024
@04kash
Copy link
Collaborator

04kash commented Dec 12, 2024

@christoph-jerolimov I haven't looked at the PR in detail but I think this would be a good addition. My only concern is that we're aiming to keep the workflows in this repo as aligned as possible with those in BCP.

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

Successfully merging this pull request may close these issues.

2 participants