Skip to content

Revamp issue/PR templates #9100

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
Merged
merged 4 commits into from
Jul 12, 2023
Merged

Revamp issue/PR templates #9100

merged 4 commits into from
Jul 12, 2023

Conversation

ffaf1
Copy link
Collaborator

@ffaf1 ffaf1 commented Jul 9, 2023 •
edited
Loading

Closes #8511.

Adds “Feature Request”, “Documentation” and “Question” issue templates.
Splits PR template in two (simple and full one), adding PR Convetion link to both.

Please include the following checklist in your PR:

Bonus points for added automated tests! N/A

@ffaf1 ffaf1 added attention: needs-review re: devx Improving the cabal developer experience (internal issue) labels Jul 9, 2023
ulysses4ever
ulysses4ever approved these changes Jul 9, 2023
View reviewed changes
Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Terrific!

geekosaur
geekosaur approved these changes Jul 9, 2023
View reviewed changes
Copy link
Collaborator

@geekosaur geekosaur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like more could be said, but let's find out what as it gets used.

@ffaf1 ffaf1 added merge me Tell Mergify Bot to merge and removed attention: needs-review labels Jul 9, 2023
ulysses4ever
ulysses4ever reviewed Jul 9, 2023
View reviewed changes
@ulysses4ever
Copy link
Collaborator

Some comments inline...

We'd also need Documentation Report and User Question, I think. Cf. #8511.

@ffaf1 ffaf1 added squash+merge me Tell Mergify Bot to squash-merge and removed merge me Tell Mergify Bot to merge labels Jul 9, 2023
@ffaf1 ffaf1 changed the title Add “Feature request” template Add “Feature request” and “Documentation” templates Jul 9, 2023
geekosaur
geekosaur approved these changes Jul 9, 2023
View reviewed changes
Copy link
Collaborator

@geekosaur geekosaur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise looks okay.

@ulysses4ever
Copy link
Collaborator

Francesco, do you think you have energy to add labels: ["type: bug", "needs triage"] to the bug report template? (I just created "needs triage").

@ulysses4ever
Copy link
Collaborator

I'm sorry, one more thing: can we also get `labels: ["attention: needs-review"] for the PR template?

@ffaf1
Copy link
Collaborator Author

ffaf1 commented Jul 9, 2023

I'm sorry, one more thing: can we also get `labels: ["attention: needs-review"] for the PR template?

Are we sure we want to do that? What about drafts?

@ffaf1
Copy link
Collaborator Author

ffaf1 commented Jul 9, 2023

Ok I have added two more templates and some user resources in #9102.

geekosaur
geekosaur requested changes Jul 9, 2023
View reviewed changes
@ffaf1 ffaf1 changed the title Add “Feature request” and “Documentation” templates Add more issue templates Jul 9, 2023
@ulysses4ever
Copy link
Collaborator

I'm sorry, one more thing: can we also get `labels: ["attention: needs-review"] for the PR template?

Are we sure we want to do that? What about drafts?

I admit this is a bit bold but I think this is ultimately a good thing:

  • Drafts are not used here all that often.
  • It's much easier to remove annoying label (when you create a draft or at any other time) than to not to forget to add the necessary one.

I went over a dozen PRs yesterday and noticed that those requiring our attention keep slipping through cracks.

@ffaf1 ffaf1 changed the title Add more issue templates Revamp issue templates Jul 9, 2023
@ulysses4ever
Copy link
Collaborator

One more optional thing if you feel especially bold. 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.

We also need a link to https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#github-pull-request-conventions in every PR template.

@ffaf1
Copy link
Collaborator Author

ffaf1 commented Jul 9, 2023

I added attention: needs-review label, if it is annoying we can always remove it at a later time (or maybe find a way to add it only to non-draft PRs).

For the simplified PR template I say: the idea is not bad let’s keep this in the scope of #8511 and discuss it in another issue!

@ulysses4ever
Copy link
Collaborator

Gotcha, thanks so much!!!

@ffaf1 ffaf1 force-pushed the feature-request-template branch from 6b28b66 to 952b5fe Compare July 9, 2023 19:05
@ffaf1 ffaf1 changed the title Revamp issue templates Revamp issue/PR templates Jul 10, 2023
@ffaf1
Copy link
Collaborator Author

ffaf1 commented Jul 10, 2023

I split the template and added a link to Github PR conventions. That should be all for #8511.

@ulysses4ever
Copy link
Collaborator

This looks paramount! Thank you!

@geekosaur geekosaur mentioned this pull request Jul 11, 2023
Open
@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Jul 12, 2023
@ulysses4ever
Copy link
Collaborator

@mergify rebase

ffaf1 added 3 commits July 12, 2023 11:35
@ffaf1 @ulysses4ever
Revamp issue templates
b1da3de 
* Add “Feature request” template

* Integrate Artem’s review

- `cabal` → Cabal
- add “type: enhancement” label

* Add “Documentation” issue template

* Add labels to “Bug report” template.

“type: bug” and ”needs-triage”. Suggested by Artem.

* Add “Question” issue template

* Fix typos

Spotted by Brandon.

* Fix English in “Question” template

Fix by Brandon.

Add “needs-review” to Pull Request template

As suggested by Artem.
@ffaf1 @ulysses4ever
Split PR template in two
9edc3d4 
Split in full (PR modifies `cabal` behaviour) and simple (otherwise).
@ffaf1 @ulysses4ever
Add Github PR Convention to PR templates
1a1a8c0
@mergify
Copy link
Contributor

mergify bot commented Jul 12, 2023

rebase

✅ Branch has been successfully rebased

@ulysses4ever ulysses4ever force-pushed the feature-request-template branch from d83e14f to 1a1a8c0 Compare July 12, 2023 11:35
@mergify mergify bot merged commit ec32da7 into haskell:master Jul 12, 2023
@ffaf1
Copy link
Collaborator Author

ffaf1 commented Jul 12, 2023 via email

@ffaf1 ffaf1 deleted the feature-request-template branch July 12, 2023 16:02
@ffaf1 ffaf1 mentioned this pull request Jul 12, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ulysses4ever ulysses4ever ulysses4ever approved these changes

@geekosaur geekosaur geekosaur approved these changes

Assignees
No one assigned
Labels
merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days re: devx Improving the cabal developer experience (internal issue) squash+merge me Tell Mergify Bot to squash-merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update PR and issue templates
3 participants
@ffaf1 @ulysses4ever @geekosaur