search

narwhals-dev / narwhals

Lightweight and extensible compatibility layer between dataframe libraries!
https://narwhals-dev.github.io/narwhals/
MIT License
572 stars 89 forks source link

Release Drafter follow up #263

Closed DeaMariaLeon closed 5 months ago

DeaMariaLeon commented 5 months ago

As a reminder, the release drafter classifies the pull requests based on their titles. The drafter is working, but we need to agree on how to handle those titles.

If a PR's title is not correct, it won't be classified under the correct type.

Polars asks contributors to start their PR with a conventional commit name. And they use ~this library as well~: https://www.conventionalcommits.org/en/v1.0.0/#summary

We could do as Polars. Another way would be to modify the regular expressions on .github/release-drafter.yml, to try to correct the classification. As I already did for the "documentation" label:

- label: documentation
    title:
      - '/(.*doc|.*docstring)/'

I would like to know what you prefer.

MarcoGorelli commented 5 months ago

thanks @DeaMariaLeon for doing this, the draft release already looks nice!

conventional commits sounds fine? we can just add this to CONTRIBUTING.md and be a bit stricter about asking people to title their PRs correctly. and before making a release, check that they're all titled correctly

FBruzzesi commented 5 months ago

It is also possible for maintainers to modify the PR title before merging (that's the famous human in the loop 😂)