search

python-discord / bot

The community bot for the Python Discord community
https://pythondiscord.com
MIT License
1.36k stars 670 forks source link

Add issue templates to the repo #1599

Open Kronifer opened 3 years ago

Kronifer commented 3 years ago

In sir-lancebot, there are currently issue templates for ease of use, and uniform issues. I suggest we either move the sir lancebot issue templates to the repo or create new ones.

HassanAbouelela commented 3 years ago

Duplicate of python-discord/organisation#268. This probably won't be actioned until the next core-dev meeting.

Kronifer commented 3 years ago

When is that?

HassanAbouelela commented 3 years ago

There is currently nothing scheduled. @Xithrius, @Akarys42 thoughts?

Kronifer commented 3 years ago

Since I do not have access to that issue, im assuming that it is for issue templates across repos

Akarys42 commented 3 years ago

I don’t think we reached a consensus on this, although here are my thoughts:

I’m not sure if locking ourselves in with a template issue is a good idea. I think having this freedom of structuring it as we want makes us more efficient and we can assume most of our users know how to write a good issue. It feels also quite bureaucratic.

It isn’t mentioned in the issue but a contrario I’d say copying the PR template over would be a good idea. You don’t need much freeway when writing PRs and it can force everyone to structure it well.

Kronifer commented 3 years ago

I'd be fine with just going with the PR template, but I think at least having templates would be a good idea. We could provide a blank template for people to use as well.

Kronifer commented 3 years ago

Whats the status on this?

Xithrius commented 3 years ago

We're probably not going to add templates, as this repository is meant for more advanced users after coming from sir-lancebot.

Along with that, I agree that there should be no need for a format of PRs in terms of initial comments.

HassanAbouelela commented 3 years ago

I've seen it brought up a few times now, and I disagree with the notion that "advanced" users don't find templates helpful.

Templates have a few benefits:

  1. They guide beginners about what they should add, but
  2. They also guide any user about what they should add.

You can know what you should add, but still forget something. I also personally find it easier to give the required details, when it's more of a questionnaire than an open-ended response. I'd personally like to see issue templates in this repo as well.

I don't have as strong an opinion about PR templates.

Xithrius commented 3 years ago

Should we have issue templates that are more simplified than sir-lance's, or the same?

HassanAbouelela commented 3 years ago

There are a few things in lance's template that I would like changed, but besides those, I think having the templates be identical would be the easiest choice, both in terms of maintenance and user-friendliness.

Xithrius commented 3 years ago

After giving it some more thought, I think both the issue and PR templates should be copied from the sir-lancebot repository and put into this one.

Besides that, they should not be enforced as not all PRs require the templates that we will be providing.

Looking at the current issue templates for sir-lancebot, is there anything that you think should be added or modified, @HassanAbouelela? I think the current state of them should do.

HassanAbouelela commented 3 years ago

No problems here, would love to have them. 👍

MarkKoz commented 3 years ago

The format of the templates was discussed a long time ago in python-discord/organisation#268 but never actioned. I don't think we really came to a conclusion. I personally think some templates need changes. We should also invest in https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository as Chris mentioned in that issue.

Kronifer commented 3 years ago

Whats the status of this?

onerandomusername commented 2 years ago

TBH We can have issue templates and still allow a user to not use the templates, so its very easy to have the best of both worlds. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser

You can encourage contributors to use issue templates by setting blank_issues_enabled to false. If you set blank_issues_enabled to true, people will have the option to open a blank issue.