Re: Add an issue description template
On 11/6/19 12:24 AM, Christian Lenz wrote: Feel free to have a look/change it and maybe we can create a Infra ticket soon for that improvement. I think there are not that much concerns about it so it is good to go. I opened the following issue with Apache Infrastructure. INFRA-19430: Add an issue description template https://issues.apache.org/jira/browse/INFRA-19430 Please add your comments about the template and your suggestions for improving it directly to that issue. If I got the template wrong, this could backfire and make them even worse, but our current notice to copy and paste the log files is just asking for bad bug reports. :-) Thank you, John - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
AW: Add an issue description template
My examples were not about using markdown, just give you an example on how others do it I’m fine with everything comes up with a better process than now. Thats it @laszlo great Idea with the JavaFX Thing Von: John Neffenger Gesendet: Sonntag, 10. November 2019 20:07 An: dev@netbeans.apache.org Betreff: Re: Add an issue description template On 11/10/19 7:40 AM, Christian Lenz wrote: > Sure, I mean they have separated fields if we can handle this under Apache, > to have suche a template, why not. I don’t want to exegerate it. Using a > plain text like others do in Github, for example here: > https://github.com/microsoft/vscode/issues/new?template=bug_report.md or > here: https://github.com/junichi11/netbeans-wordpress-plugin/issues/new smth > simple with text inside the description field. Right. I think I'll drop the text effects (italic and bold) and keep just the headings (h3). That makes it more legible as plain text. The examples above use Markdown, though, and it seems we're stuck with the less well-known Jira notation. I found a Markdown plug-in for Jira, but I'm not sure how the switch in markup would work at Apache. By the way, for our own bug reports, it's easy to write them in Markdown and convert them to Jira notation using Pandoc! For details, see the Bash script in my comment here: Minor formatting issues with Jira output https://github.com/jgm/pandoc/issues/5858#issuecomment-551900899 There's also a link to a Makefile I use at the top of that issue. John - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: Add an issue description template
On 11/10/19 7:40 AM, Christian Lenz wrote: Sure, I mean they have separated fields if we can handle this under Apache, to have suche a template, why not. I don’t want to exegerate it. Using a plain text like others do in Github, for example here: https://github.com/microsoft/vscode/issues/new?template=bug_report.md or here: https://github.com/junichi11/netbeans-wordpress-plugin/issues/new smth simple with text inside the description field. Right. I think I'll drop the text effects (italic and bold) and keep just the headings (h3). That makes it more legible as plain text. The examples above use Markdown, though, and it seems we're stuck with the less well-known Jira notation. I found a Markdown plug-in for Jira, but I'm not sure how the switch in markup would work at Apache. By the way, for our own bug reports, it's easy to write them in Markdown and convert them to Jira notation using Pandoc! For details, see the Bash script in my comment here: Minor formatting issues with Jira output https://github.com/jgm/pandoc/issues/5858#issuecomment-551900899 There's also a link to a Makefile I use at the top of that issue. John - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: Add an issue description template
We can set up such a Template in JIRA (it has a function like that). It provides a specific URL for that template. We could embed that url into a JavaFX web component and we would have a bug reporting tool. On 11/8/19 10:30 AM, John Neffenger wrote: On 11/6/19 12:24 AM, Christian Lenz wrote: Feel free to have a look/change it and maybe we can create a Infra ticket soon for that improvement. I think there are not that much concerns about it so it is good to go. Thank you, Chris. What do you think about starting with the Java bug report template that the JDK has used for years? Report a Bug or Request a Feature https://bugreport.java.com/bugreport/ I reproduced that template below in Jira notation, adding a brief introduction. Just copy and paste it into a new Jira issue to see the formatting (and then Cancel). I think it's particularly helpful to add a link to the Jira Text Formatting Notation Help. To get a template added, would I open an issue with the project below? ASF infrastructure https://issues.apache.org/jira/projects/INFRA/summary Thanks, John -- _Replace the italicized text in this template with your own text, leaving the headings._ _Add any log reports, such as the *UI Log* or *IDE Log*, as *attachments*; please do not copy and paste them into this description._ _For help with the formatting, see the Jira [Text Formatting Notation Help|https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=texteffects]_. h3. Synopsis _Enter a one line summary of your report here and in the Summary field above._ _Please be specific._ h3. Description _Enter a detailed description of the problem._ _Please describe only one problem per report._ _For multiple problems, file a separate report for each one._ h3. System / OS / Java Runtime Information _Place additional system configuration information here and in the Environment field below._ h3. Steps to Reproduce _Describe the step-by-step process we can follow to reproduce this bug._ h3. Expected Results _Describe the results you were expecting when performing the above steps._ h3. Actual Result _Please report the actual results that you saw with the exact text of any error messages that appeared or any trace information available._ h3. Source code for an executable test case _Add the complete Java source code that compiles and demonstrates the problem, if available._ h3. Workaround _Please provide a temporary method for bypassing this bug, if you have found one._ - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
AW: Add an issue description template
Sure, I mean they have separated fields if we can handle this under Apache, to have suche a template, why not. I don’t want to exegerate it. Using a plain text like others do in Github, for example here: https://github.com/microsoft/vscode/issues/new?template=bug_report.md or here: https://github.com/junichi11/netbeans-wordpress-plugin/issues/new smth simple with text inside the description field. But sure, go for it. Yes, you should create a INFRA ticket first. Maybe they already have smth like that, for that, you can ask at infra.chat Cheers Chris Von: John Neffenger Gesendet: Freitag, 8. November 2019 19:30 An: dev@netbeans.apache.org Betreff: Re: Add an issue description template On 11/6/19 12:24 AM, Christian Lenz wrote: > Feel free to have a look/change it and maybe we can create a Infra ticket > soon for that improvement. I think there are not that much concerns about it > so it is good to go. Thank you, Chris. What do you think about starting with the Java bug report template that the JDK has used for years? Report a Bug or Request a Feature https://bugreport.java.com/bugreport/ I reproduced that template below in Jira notation, adding a brief introduction. Just copy and paste it into a new Jira issue to see the formatting (and then Cancel). I think it's particularly helpful to add a link to the Jira Text Formatting Notation Help. To get a template added, would I open an issue with the project below? ASF infrastructure https://issues.apache.org/jira/projects/INFRA/summary Thanks, John -- _Replace the italicized text in this template with your own text, leaving the headings._ _Add any log reports, such as the *UI Log* or *IDE Log*, as *attachments*; please do not copy and paste them into this description._ _For help with the formatting, see the Jira [Text Formatting Notation Help|https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=texteffects]_. h3. Synopsis _Enter a one line summary of your report here and in the Summary field above._ _Please be specific._ h3. Description _Enter a detailed description of the problem._ _Please describe only one problem per report._ _For multiple problems, file a separate report for each one._ h3. System / OS / Java Runtime Information _Place additional system configuration information here and in the Environment field below._ h3. Steps to Reproduce _Describe the step-by-step process we can follow to reproduce this bug._ h3. Expected Results _Describe the results you were expecting when performing the above steps._ h3. Actual Result _Please report the actual results that you saw with the exact text of any error messages that appeared or any trace information available._ h3. Source code for an executable test case _Add the complete Java source code that compiles and demonstrates the problem, if available._ h3. Workaround _Please provide a temporary method for bypassing this bug, if you have found one._ - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: Add an issue description template
On 11/6/19 12:24 AM, Christian Lenz wrote: Feel free to have a look/change it and maybe we can create a Infra ticket soon for that improvement. I think there are not that much concerns about it so it is good to go. Thank you, Chris. What do you think about starting with the Java bug report template that the JDK has used for years? Report a Bug or Request a Feature https://bugreport.java.com/bugreport/ I reproduced that template below in Jira notation, adding a brief introduction. Just copy and paste it into a new Jira issue to see the formatting (and then Cancel). I think it's particularly helpful to add a link to the Jira Text Formatting Notation Help. To get a template added, would I open an issue with the project below? ASF infrastructure https://issues.apache.org/jira/projects/INFRA/summary Thanks, John -- _Replace the italicized text in this template with your own text, leaving the headings._ _Add any log reports, such as the *UI Log* or *IDE Log*, as *attachments*; please do not copy and paste them into this description._ _For help with the formatting, see the Jira [Text Formatting Notation Help|https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=texteffects]_. h3. Synopsis _Enter a one line summary of your report here and in the Summary field above._ _Please be specific._ h3. Description _Enter a detailed description of the problem._ _Please describe only one problem per report._ _For multiple problems, file a separate report for each one._ h3. System / OS / Java Runtime Information _Place additional system configuration information here and in the Environment field below._ h3. Steps to Reproduce _Describe the step-by-step process we can follow to reproduce this bug._ h3. Expected Results _Describe the results you were expecting when performing the above steps._ h3. Actual Result _Please report the actual results that you saw with the exact text of any error messages that appeared or any trace information available._ h3. Source code for an executable test case _Add the complete Java source code that compiles and demonstrates the problem, if available._ h3. Workaround _Please provide a temporary method for bypassing this bug, if you have found one._ - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
AW: Add an issue description template
Hey John, to (1): I came up with this idea I think 2 or 3 times, but not specific for that long log case, more as a General solution. Creating a template for Bugs with a description and steps to reprocuce, etc. So that can prevent (not 100% for sure) first, developers from creating tickets only when an exception came up and they want to catch them in a single line ticket and it will make the tickets more valuable. Here is my proposal: https://pastebin.com/hcx7SDUb Feel free to have a look/change it and maybe we can create a Infra ticket soon for that improvement. I think there are not that much concerns about it so it is good to go. Cheers Chris Von: John Neffenger Gesendet: Dienstag, 5. November 2019 18:15 An: Apache NetBeans Betreff: Add an issue description template I notice that many new issues are created by copying and pasting the entire UI Log or IDE Log (or both) from a NetBeans View Data error report into the issue description field. The Jira formatting makes it difficult to find the error and stack trace, and the large amount of text, often interpreted as Jira notation, causes my browser to hang when editing it. For example, I managed to move the log files to Attachments and the Docs Text to Description in the following issue, but it wasn't easy, and this was on a powerful workstation with the latest Firefox. NETBEANS-3340: Code Completion/Insertion Stops Working. Internal Exception Thrown https://issues.apache.org/jira/browse/NETBEANS-3340 I have three questions: (1) Could we add some template text to the Create Issue Description field asking people to add the UI Log and IDE Log as attachments, preferably with a ".txt" file extension so that they open right in the browser? (2) As a longer-term solution, may I open an Improvement Issue to add a Save button to the NetBeans View Data report that will save the UI Log and IDE Log as text files for attaching later instead of asking people to copy and paste them? See the current text below. [*] (3) It appears that these exception reports are logged automatically somewhere. Where on the Internet are all these exceptions being recorded? If we already have them, we don't need the Jira issue. Thanks, John -- [*] Report Problem text: You have found a bug in the application! Please help Apache NetBeans by reporting this problem to our bug tracking system. Click View Data button, copy the exception and submit it together with detailed information about what you were trying to achieve before the problem occurred in JIRA. Thank you for helping us make Apache NetBeans better! - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Add an issue description template
I notice that many new issues are created by copying and pasting the entire UI Log or IDE Log (or both) from a NetBeans View Data error report into the issue description field. The Jira formatting makes it difficult to find the error and stack trace, and the large amount of text, often interpreted as Jira notation, causes my browser to hang when editing it. For example, I managed to move the log files to Attachments and the Docs Text to Description in the following issue, but it wasn't easy, and this was on a powerful workstation with the latest Firefox. NETBEANS-3340: Code Completion/Insertion Stops Working. Internal Exception Thrown https://issues.apache.org/jira/browse/NETBEANS-3340 I have three questions: (1) Could we add some template text to the Create Issue Description field asking people to add the UI Log and IDE Log as attachments, preferably with a ".txt" file extension so that they open right in the browser? (2) As a longer-term solution, may I open an Improvement Issue to add a Save button to the NetBeans View Data report that will save the UI Log and IDE Log as text files for attaching later instead of asking people to copy and paste them? See the current text below. [*] (3) It appears that these exception reports are logged automatically somewhere. Where on the Internet are all these exceptions being recorded? If we already have them, we don't need the Jira issue. Thanks, John -- [*] Report Problem text: You have found a bug in the application! Please help Apache NetBeans by reporting this problem to our bug tracking system. Click View Data button, copy the exception and submit it together with detailed information about what you were trying to achieve before the problem occurred in JIRA. Thank you for helping us make Apache NetBeans better! - To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org For additional commands, e-mail: dev-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
