First take at creating a GitHub issue template #5652

hamoid · 2017-06-08T09:54:06Z

No description provided.

arturoc · 2017-06-08T10:18:48Z

That's really nice, i think there's a way to show this as a message for people sending issues for the first time, i'll take a look when i have a moment

hamoid · 2017-06-08T10:20:08Z

https://github.com/blog/2111-issue-and-pull-request-templates

I think it would be automatically shown in the text box when clicking "new issue", for everyone. You can, as a user, delete the predefined text and type whatever you want.

Is that what you meant? Or you mean there's a way to only show it once?

hamoid · 2017-06-08T10:34:24Z

It's also possible to create a template for pull requests, but I have no experience with what's a good template. Anything you want people to write in a pull request? Some kind of reminder?

bakercp · 2017-06-14T15:45:57Z

Hey there, I just took a first pass at some edits additions. The main goal of my additions was to differentiate between "questions" (which go to forum) and "issues" which are documented and (hopefully) reproducible.

hamoid · 2017-06-15T21:27:40Z

Hi @bakercp ! where are your edits visible?

bakercp · 2017-06-15T21:30:31Z

I just put them in the review comments ...

hamoid · 2017-06-15T21:55:19Z

I don't know where to click to see the comments. Are they only visible to members of the OF organization?

bakercp · 2017-06-14T15:39:23Z

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,32 @@
+Nice! You found an issue! :) Get help faster by providing the following details:


A very quick definition of what an "issue" is vs. what a "how do i .. ?" is would be good here. The goal is to both get better issue reports and also to send people with "how to" questions to the forum for triage before filing official issues. So maybe a checklist for "is this an issue"?

### The issue tracker is for "issues", the openFrameworks forum is for questions. What is the difference? A obvious question might be "How do I get openFrameworks to compile on Android?" An obvious issue might be "The function `ofRandom()` only returns the number 42 on Linux Ubuntu 16.04". When you submit an issue, you are certain that the expected result and the actual result _are not the same_ and you must have some code to demonstrate it. If you aren't certain what the "expected" result is (due to poor documentation), then please first ask about it on the forum https://forum.openframeworks.cc. There's a good chance there's a real issue, but please post it on the forum if you are in doubt.

About "code to demonstrate it", what if it's an improvement or new feature? Isn't it enough to have the block of code at the end to imply this?

bakercp · 2017-06-14T15:40:26Z

.github/ISSUE_TEMPLATE.md

+void ofApp::draw() {
+  cout << x << endl;
+}
+```


### Proposed Solution (describe your proposed solution if you have one)

bakercp · 2017-06-14T15:43:00Z

.github/ISSUE_TEMPLATE.md

+(explain here)
+
+### A minimal program showing the issue: 
+


_Please make sure each section of your example code is code-fenced like below the example below._

bakercp · 2017-06-14T15:43:56Z

.github/ISSUE_TEMPLATE.md

+* Graphics card drivers:   [Linux: the output of `glxinfo -B`, in Mac ..., Windows: start > run > dxdiag ]
+
+### Expected result of my program
+


_Why do you expect this result?_

bakercp · 2017-06-14T15:44:32Z

.github/ISSUE_TEMPLATE.md

+(explain here)
+
+### Actual result of my program
+


_Please include screen-shots or photos for issues that involve graphics._

bakercp · 2017-06-15T22:18:42Z

Oh. Apparently you have to press "Submit Review" ... can you see it now?

hamoid · 2017-06-15T22:25:38Z

I see it now, thanks! I'll add my comments soon.

bakercp · 2017-06-28T18:24:36Z

Hey, what do you think of this check-box approach? Too much?

https://github.com/pi-hole/pi-hole/blob/master/.github/ISSUE_TEMPLATE.md

hamoid · 2017-06-29T09:47:03Z

That one in particular reminds me a bit of government forms, a bit too serious :) But the checkboxes may be useful.

I'll first push some changes following your comments, and lets continue from there.

hamoid · 2017-06-29T09:56:42Z

Another topic: should it be mention that it's not just issues vs questions, but issues in the openFrameworks code (or documentation) vs issues in your own code?

hamoid · 2017-06-29T09:58:11Z

Some template examples: https://github.com/stevemao/github-issue-templates

arturoc · 2017-07-04T12:24:09Z

This is looking great but isn't it a bit too long if it's what everyone is going to see when submitting an issue? i don't think the explanation of issue vs question belongs here so tbh i prefer your first version or something more concise even.

@bakercp what do you think?

bakercp · 2017-07-05T19:33:16Z

Minimal is fine. I agree, it's a lot of text in its current form, so I'd say we should refactor some of the more instructive / pedagogical bits into a refined contributing document. My main goals are to get a good report the first time, rather than having long back-and-forth conversations trying extract information from people. So the basics would just include ...

Help people figure out if they should post here or on the forum (question vs. issue).
-- This could be a single sentence with a link more text / examples in the contributing readme.
Get info on hardware / software versions.
Get expected vs. actual results (with images if relevant)
Get a minimal example / steps to reproduce (with code fences!)

arturoc · 2017-07-05T22:30:17Z

I don't think the explanation of question/issue belongs in a template really, this is something that will appear for everyone when filling an issue so it should be really straightforward to just fill in. And it shouldn't get in the way, you shouldn't have to remove anything except perhaps to replace it i think.

Having to delete that bit even if it's just one sentence every time you open an issue can get annoying i think

Also if people see the rest of the template (hardware, description of the issue, minimal example...) i think most people will understand that it's referring to an issue and not a question

I really prefer to point to the forum and close a couple of questions every year (i don't think the frequency right now is much higher than that) than having to delete parts of the template every time i open an issue

hamoid · 2017-07-08T10:19:40Z

I also feel it's too much information to read. We could add a simple "If this is your first issue, please read this before continuing" at the top (with a link to a separate document).

This way we can keep it short, and put the details and explanations in the wiki. Would that work better?

bakercp · 2017-07-08T18:29:48Z

That sounds like the right approach.

…

On Sat, Jul 8, 2017, 5:19 AM Abe Pazos ***@***.***> wrote: I also feel it's too much information to read. We could add a simple "If this is your first issue, please read this before continuing" at the top. This way we can keep it short, and put the details and explanations in the wiki. Would that work better? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5652 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AASVxJJ4GOM5FbuOob7oxdNT0-99CiH7ks5sL1e9gaJpZM4Nz1ee> .

hamoid · 2018-01-08T11:00:16Z

Should I add Getting help with OpenFrameworks at the top of the wiki ? Alternatives names:

Asking for help
Asking for help: forum vs issues
How to ask for help
I need help with OpenFrameworks
...

I'll move text out from .github/ISSUE_TEMPLATE.md into that wiki page, which will explain when to use the forum and when to post issues, and how to post a useful issue.

At the top of the template I'll write:

Read https://github.com/openframeworks/openFrameworks/wiki/asking-for-help before posting your first OpenFrameworks issue

How does that sound like?

hamoid · 2018-05-03T08:25:32Z

Now it's possible to create multiple templates for different kinds of issues:
https://blog.github.com/2018-05-02-issue-template-improvements/

dimitre · 2022-05-20T21:28:11Z

My favorite template is the blank one, but maybe a really basic template would have

platform and OS version:
OF version:

First take at creating a GitHub issue template

1318f76

hamoid mentioned this pull request Jun 8, 2017

Create issue template for GitHub #5628

Open

bakercp reviewed Jun 15, 2017

View reviewed changes

Issue template changes based on received feedback

f4e796f

ofTheo added this to the 0.11.1 milestone Dec 1, 2019

ofTheo mentioned this pull request Dec 1, 2019

OF 0.11.1 Release Checklist #6483

Closed

48 tasks

ofTheo mentioned this pull request Feb 23, 2021

OF 0.12.0 Release Checklist #6692

Closed

77 tasks

ofTheo modified the milestones: 0.11.1, 0.12.0 Mar 3, 2021

hamoid closed this by deleting the head repository Mar 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First take at creating a GitHub issue template #5652

First take at creating a GitHub issue template #5652

hamoid commented Jun 8, 2017

arturoc commented Jun 8, 2017

hamoid commented Jun 8, 2017 •

edited

Loading

hamoid commented Jun 8, 2017

bakercp commented Jun 14, 2017

hamoid commented Jun 15, 2017

bakercp commented Jun 15, 2017

hamoid commented Jun 15, 2017

bakercp Jun 14, 2017

hamoid Jun 29, 2017

bakercp Jun 14, 2017

bakercp Jun 14, 2017

bakercp Jun 14, 2017

bakercp Jun 14, 2017

bakercp commented Jun 15, 2017

hamoid commented Jun 15, 2017

bakercp commented Jun 28, 2017

hamoid commented Jun 29, 2017

hamoid commented Jun 29, 2017 •

edited

Loading

hamoid commented Jun 29, 2017

arturoc commented Jul 4, 2017

bakercp commented Jul 5, 2017

arturoc commented Jul 5, 2017 •

edited

Loading

hamoid commented Jul 8, 2017 •

edited

Loading

bakercp commented Jul 8, 2017 via email

hamoid commented Jan 8, 2018

hamoid commented May 3, 2018 •

edited

Loading

dimitre commented May 20, 2022

		@@ -0,0 +1,32 @@
		Nice! You found an issue! :) Get help faster by providing the following details:

		* Graphics card drivers: [Linux: the output of `glxinfo -B`, in Mac ..., Windows: start > run > dxdiag ]

		### Expected result of my program

First take at creating a GitHub issue template #5652

First take at creating a GitHub issue template #5652

Conversation

hamoid commented Jun 8, 2017

arturoc commented Jun 8, 2017

hamoid commented Jun 8, 2017 • edited Loading

hamoid commented Jun 8, 2017

bakercp commented Jun 14, 2017

hamoid commented Jun 15, 2017

bakercp commented Jun 15, 2017

hamoid commented Jun 15, 2017

bakercp Jun 14, 2017

Choose a reason for hiding this comment

hamoid Jun 29, 2017

Choose a reason for hiding this comment

bakercp Jun 14, 2017

Choose a reason for hiding this comment

bakercp Jun 14, 2017

Choose a reason for hiding this comment

bakercp Jun 14, 2017

Choose a reason for hiding this comment

bakercp Jun 14, 2017

Choose a reason for hiding this comment

bakercp commented Jun 15, 2017

hamoid commented Jun 15, 2017

bakercp commented Jun 28, 2017

hamoid commented Jun 29, 2017

hamoid commented Jun 29, 2017 • edited Loading

hamoid commented Jun 29, 2017

arturoc commented Jul 4, 2017

bakercp commented Jul 5, 2017

arturoc commented Jul 5, 2017 • edited Loading

hamoid commented Jul 8, 2017 • edited Loading

bakercp commented Jul 8, 2017 via email

hamoid commented Jan 8, 2018

hamoid commented May 3, 2018 • edited Loading

dimitre commented May 20, 2022

hamoid commented Jun 8, 2017 •

edited

Loading

hamoid commented Jun 29, 2017 •

edited

Loading

arturoc commented Jul 5, 2017 •

edited

Loading

hamoid commented Jul 8, 2017 •

edited

Loading

hamoid commented May 3, 2018 •

edited

Loading