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.

Sign up for GitHub

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

Jump to bottom

PR template: Make it better! #10575

Open
9999years opened this issue Nov 21, 2024 · 2 comments · May be fixed by #10594
Open

PR template: Make it better! #10575

9999years opened this issue Nov 21, 2024 · 2 comments · May be fixed by #10594
Labels
github_actions Pull requests that update GitHub Actions code re: changelog Concerning the change log re: devx Improving the cabal developer experience (internal issue)

Comments

@9999years
Copy link
Collaborator

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.
@9999years 9999years added documentation re: devx Improving the cabal developer experience (internal issue) re: changelog Concerning the change log github_actions Pull requests that update GitHub Actions code and removed documentation labels Nov 21, 2024
@ffaf1
Copy link
Collaborator

ffaf1 commented Nov 21, 2024

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
Copy link
Collaborator

ffaf1 commented Nov 21, 2024

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.

@9999years 9999years linked a pull request Nov 25, 2024 that will close this issue
Open
@geekosaur geekosaur mentioned this issue Dec 2, 2024
Draft
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
github_actions Pull requests that update GitHub Actions code re: changelog Concerning the change log re: devx Improving the cabal developer experience (internal issue)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

PR template: Make it better! 9999years/cabal
2 participants
@9999years @ffaf1