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.

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

Update PR and issue templates #8511

Closed
3 of 5 tasks
ulysses4ever opened this issue Oct 5, 2022 · 8 comments · Fixed by #9100
Closed
3 of 5 tasks

Update PR and issue templates #8511

ulysses4ever opened this issue Oct 5, 2022 · 8 comments · Fixed by #9100

Comments

@ulysses4ever
Copy link
Collaborator

ulysses4ever commented Oct 5, 2022

  • refer to CONTRIBUTING.md
  • add templates for things other than bugs (presumably, "enhancement", "documentation")
  • ditch mention of v2- commands: they've been long the default
  • add simplified PR template (see below)
  • refer to master/CONTRIBUTING.md#github-pull-request-conventions in every PR template

Originally posted by @Mikolaj in #6370 (comment)

Simplified PR template

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.

See also:

@ulysses4ever ulysses4ever changed the title Update PR templates Update PR and issue templates Oct 5, 2022
@ulysses4ever
Copy link
Collaborator Author

Actually, a reference to CONTRIBUTING.md is already made in the current PR template.

@Mikolaj
Copy link
Member

Mikolaj commented Oct 17, 2022

Actually, a reference to CONTRIBUTING.md is already made in the current PR template.

I guess it's only to specific sections, but I agree this is enough. So only the issue templates remain to do.

@ffaf1
Copy link
Collaborator

ffaf1 commented Jul 9, 2023

Do we (in general) want a “User questions” template? (edit: Ok, I am seeing what stack does and it correctly points first and foremost to Discourse).

@geekosaur
Copy link
Collaborator

I'd say that's either Discourse or possibly the Discussions area. (Might be worth considering that it's very easy to switch something between Discussion and Issue on GH.)

@ulysses4ever
Copy link
Collaborator Author

I don't have a strong feeling about questions. We don't receive many of those anyway. I just felt that it may seem more welcoming to have it. And I'd much rather answer Cabal questions here instead of anywhere else, but I realize that it may be undesirable for some reasons.

@ulysses4ever
Copy link
Collaborator Author

I updated the description with a "simplified PR template". Please, share your thoughts!

@ffaf1
Copy link
Collaborator

ffaf1 commented Jul 9, 2023

Where would I choose the simplified template? When I make a PR? Would it be default?

@ulysses4ever
Copy link
Collaborator Author

@ffaf1 when you push the green button, just like with issues, no? I did double-check that GitHub allows several PR templates.

@mergify mergify bot closed this as completed in #9100 Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants