Add slightly modified version of GATK3 github issue template #4796
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| ### Instructions | ||
|
|
||
| The github issue tracker is for bug reports, feature requests, and API documentation requests. General questions about how to use the GATK, how to interpret the output, etc. should be asked on the [official support forum](http://gatkforums.broadinstitute.org/gatk). | ||
| - Search the existing github issues to see if your issue (or something similar) has already been reported. If the issue already exists, you may comment there to inquire about the progress. | ||
| - Determine whether your issue is a **bug report**, a **feature request**, or a **documentation request** (for tool gatkdocs only -- for forum docs see [the support issues repo](https://github.com/broadinstitute/dsde-docs/issues)) | ||
| - Consider if your "issue" is better addressed on the GATK forum: http://gatkforums.broadinstitute.org/gatk Post there if you have questions about expected tool behavior, output format, unexpected results, or generally any question that does not fit into the categories above | ||
| - Use a **concise** yet **descriptive** title | ||
| - Choose the corresponding template block below and fill it in, replacing or deleting text in italics (surrounded by `_`) as appropriate | ||
|
There was a problem hiding this comment. Templates are focused on tool(s), but there isn't any guideline for engine suggestions - this is important for developers using GATK4 as a framework (that's my case). There was a problem hiding this comment. If you're savvy enough to make feature requests for the engine, you probably can write a good issue without a template. :-) @droazen or @lbergelson thoughts? There was a problem hiding this comment. I see your point @ldgauthier, but I think @magicDGS's point is worth addressing. The issue template is one of the first exposures people trying to contribute something have, so if it's an awkward match to what they're trying to tell us it is sort of dispiriting. What if we clarify it by changing the wording to There was a problem hiding this comment. @magicDGS Would that make it seem better for your use case? Or do you have a different suggestion for an alternative template or something like that? There was a problem hiding this comment. I am ok with both the tool-driven and your proposal - I was just wondering what is the best way to submit an issue/proposal for the engine (as I do often), because I am planning to follow as much as possible the templates. I think that the addition of "Classes" might be good for letting know people that the template is the same for engine/tools. Thanks for considering my opinion! |
||
| - Delete the other template blocks and this header. | ||
|
|
||
| ---- | ||
|
|
||
| ## Bug Report | ||
|
|
||
| ### Affected tool(s) | ||
| _Tool name(s), special parameters?_ | ||
|
|
||
| ### Affected version(s) | ||
| - [ ] Latest public release version [version?] | ||
| - [ ] Latest master branch as of [date of test?] | ||
|
|
||
| ### Description | ||
| _Describe the problem below. Provide **screenshots** , **stacktrace** , **logs** where appropriate._ | ||
|
|
||
| #### Steps to reproduce | ||
| _Tell us how to reproduce this issue. If possible, include command lines that reproduce the problem. (The support team may follow up to ask you to upload data to reproduce the issue.)_ | ||
|
|
||
| #### Expected behavior | ||
| _Tell us what should happen_ | ||
|
|
||
| #### Actual behavior | ||
| _Tell us what happens instead_ | ||
|
|
||
| ---- | ||
|
|
||
| ## Feature request | ||
|
|
||
| ### Tool(s) involved | ||
| _Tool name(s), special parameters?_ | ||
|
|
||
| ### Description | ||
| _Specify whether you want a modification of an existing behavior or addition of a new capability._ | ||
| _Provide **examples**, **screenshots**, where appropriate._ | ||
|
|
||
| ---- | ||
|
|
||
| ## Documentation request | ||
|
|
||
| ### Tool(s) involved | ||
| _Tool name(s), parameters?_ | ||
|
|
||
| ### Description | ||
| _Describe what needs to be added or modified._ | ||
|
|
||
| ---- | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe tool gatk docs -> javadoc ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By the way, I guess that the repository is private - it might be a good idea to mention it, because I was trying to access and I was wondering why it didn't work. I can't submit an issue about forum docs, but I guess that I would not realize if there is an issue there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh. I didn't realize that. We should not link to a private repository.