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

Use Github Issue Templates #2162

Open
codebrainz opened this issue May 24, 2019 · 3 comments
Open

Use Github Issue Templates #2162

codebrainz opened this issue May 24, 2019 · 3 comments
Assignees
Labels
duplicate This has already been reported enhancement

Comments

@codebrainz
Copy link
Member

codebrainz commented May 24, 2019

We should use the improved version of Github Issue Templates as recommended by @andy5995 in #2063.

I have created a sample repository using almost the stock issue templates for bug reports and feature requests, except I adapted the version information section in the bug report template for our use.

Please feel free to create issues there to test what it's like with the templates.

Concretely, this means adding a .github/ISSUE_TEMPLATE directory and then a Markdown file for each issue template in that directory. Github has some kind of web-based issue template editor/previewer, which is what I used to create the two templates using almost their default contents.

References:
https://help.github.com/en/articles/about-issue-and-pull-request-templates
https://help.github.com/en/articles/creating-issue-templates-for-your-repository

Supersedes #1647 and #2063.

@codebrainz codebrainz added enhancement duplicate This has already been reported labels May 24, 2019
@codebrainz codebrainz self-assigned this May 24, 2019
@eht16
Copy link
Member

eht16 commented Jun 2, 2019

LGTM.
We probably can add another one for pull requests (based on the one for feature requests) and additionally mention tests (manual testing, different GTK versions, make distcheck, ...).

@elextr
Copy link
Member

elextr commented Jun 2, 2019

@eht16 we need to be careful what we add.

Whilst we want to encourage more complete pull requests, since we don't have surplus effort to do things ourselves more contributor effort is always appreciated, but we should not make it look like contributors must to do all these other things or that the pull request will be rejected if they are not done.

Also some of those really only apply to code changes, not to documents or configurations etc.

Since pull request contributors are more invested we can afford to make the pull request template a little more extensive than issue/feature requests, but it should be presented in a way that it is clear that it can be ignored if the contributor can't do it, or doesn't think its relevant.

@elextr
Copy link
Member

elextr commented Jun 2, 2019

I should add that the templates LGTM also. Only suggestion would be to move the version info section of the bug report up a bit to (subtly :) indicate its important.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This has already been reported enhancement
Projects
None yet
Development

No branches or pull requests

3 participants