Skip to content

Fix issue/PR templates#9117

Merged
ulysses4ever merged 4 commits into
haskell:masterfrom
ffaf1:template-fix
Jul 12, 2023
Merged

Fix issue/PR templates#9117
ulysses4ever merged 4 commits into
haskell:masterfrom
ffaf1:template-fix

Conversation

@ffaf1
Copy link
Copy Markdown
Collaborator

@ffaf1 ffaf1 commented Jul 12, 2023

See: #9100.

There are some text wrapping issue, plus it seems to me that PR templates are not shown.

@ffaf1
Unwrap text in templates
283bbba 
GitHub markdown does not do auto-unwrapping.
@ffaf1 ffaf1 added the re: devx Improving the cabal developer experience (internal issue) label Jul 12, 2023
ffaf1 added 3 commits July 12, 2023 18:42
@ffaf1
Switch to one-template PR
2d92275 
This Stack Overflow answer [1] details how to have multiple PR templates
on GitHub. The UX is not that immediate (user has to click on preview, and
then another link).
A single page with two templates (where you fill in the one you
pick and erase the other) is more friendly.

[1] https://stackoverflow.com/a/75030350
@ffaf1
Whitespace
980579a
@ffaf1
Made PR instruction impersonal
fce51c9 
For consistency with other bullet points.
@ffaf1
Copy link
Copy Markdown
Collaborator Author

ffaf1 commented Jul 12, 2023

Ok, apparently there is a trick to have multiple PR templates on GitHub, but I dislike it a lot. It involves the user having to click “Preview” and then the correct template.

So I made a single PR template where the user simply pick one of tho options and erases the other one. I will post the template as is below, in another comment. Let me know if you prefer the “Preview” option.

@ffaf1
Copy link
Copy Markdown
Collaborator Author

ffaf1 commented Jul 12, 2023

Please read Github PR Conventions and then fill in one of these two templates.

Template Α: This PR modifies cabal behaviour

Include the following checklist in your PR:

Bonus points for added automated tests!

Template Β: This PR does not modify cabal behaviour (documentation, tests, refactoring, etc.)

Include the following checklist in your PR:

@ffaf1 ffaf1 marked this pull request as ready for review July 12, 2023 16:53
@ffaf1
Copy link
Copy Markdown
Collaborator Author

ffaf1 commented Jul 12, 2023

We may want to merge this fast, or for the next two days new PRs will be templateless! I'll let someone with seniority decide.

@ffaf1 ffaf1 added the squash+merge me Tell Mergify Bot to squash-merge label Jul 12, 2023
@ulysses4ever
Copy link
Copy Markdown
Collaborator

ulysses4ever commented Jul 12, 2023

Absolutely. Will have to wait for CI to finish though.

@ulysses4ever ulysses4ever merged commit 108dc69 into haskell:master Jul 12, 2023
@ffaf1 ffaf1 deleted the template-fix branch July 12, 2023 19:14
@mergify mergify Bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@geekosaur geekosaur geekosaur approved these changes

@ulysses4ever ulysses4ever ulysses4ever approved these changes

@Kleidukos Kleidukos Kleidukos 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.

4 participants

@ffaf1 @ulysses4ever @geekosaur @Kleidukos