search

haskell / cabal

Official upstream development repository for Cabal and cabal-install
https://haskell.org/cabal
Other
1.63k stars 696 forks source link

PR template: Make it better! #10575

Open 9999years opened 2 days ago

9999years commented 2 days ago

The PR template is kinda unclear & could use some love.

Having a "part A" and "part B" is odd when they share items. We should have a "this PR changes behavior or interfaces" checkbox instead.

Automated comments for PRs that lack tests or release notes would be helpful.

ffaf1 commented 2 days ago

We should have a "this PR changes behavior or interfaces" checkbox instead.

And then a sublist of checkboxes for things that apply only to behaviour-modifying PRs?

ffaf1 commented 2 days ago

See #8511 for previous discussion. This pops out:

People keep complaining about our PR template in that it has a long set of checkboxes that are not necessarily relevant for small contributions, and those are usually made by newcomers, so they get especially confused. Maybe, we need another template: something like "Documentation" or "User-invisible change" without any checkboxes.