Eventual-Inc / Daft

Distributed data engine for Python/SQL designed for the cloud, powered by Rust
https://getdaft.io
Apache License 2.0
2.31k stars 160 forks source link

switch to conventional commits for PR labeller #2867

Open universalmind303 opened 1 month ago

universalmind303 commented 1 month ago

Is your feature request related to a problem? Please describe. we use a PR labeller with the following:

  * [FEAT]: adds the `enhancement` label
  * [PERF]: adds the `performance` label
  * [BUG]: adds the `bug` label
  * [CHORE]: adds the `chore` label
  * [DOCS]: adds the `documentation` label

but this isn't quite as flexible as 'conventional commits'. Conventional Commits are also much more widely used, I oftentimes find myself accidentally using that format instead of our non-standard format.

Additionally, many tools such as github's "generate release notes" works better with conventional commits.

Describe the solution you'd like use conventional commit style PRs instead of our custom labels.

instead of [FEAT]: my cool feature, we'd use feat: my cool feature This allows us to scope them also, which I find very useful. [FEAT]: my cool sql feature -> feat(sql): my cool sql feature

It also adds a few categories that we currently dont have instead of: [CHORE]: some change to our ci pipeline, we have a dedicated category ci: some change to our ci pipeline

Describe alternatives you've considered Leave things the way they are

Additional context https://www.conventionalcommits.org/en/v1.0.0/#summary

jaychia commented 1 month ago

I didn't know there was a standard for this -- sounds good to me!

The main things that would need to fix would be:

Should be pretty simple though