Update issue templates #2226
Update issue templates #2226
Conversation
AnthonyGlt
force-pushed
the
templates-update
branch
from
634ce14
to
fcb9cef
Compare
|
Thanks for this addition. Wouldn't we need to delete the current |
|
We can keep it, it will be used in this case: |
|
|
||
| ## Context | ||
| <!--- A description of the feature and why this feature could be interesting to implement in iTowns! --> | ||
| <!--- Current state of iTowns vs. state after implementation --> |
There was a problem hiding this comment.
The impacting changes part shall be in a dedicated part. See comment below.
| ## Context | ||
| <!--- A description of the feature and why this feature could be interesting to implement in iTowns! --> | ||
| <!--- Current state of iTowns vs. state after implementation --> | ||
|
|
There was a problem hiding this comment.
We could include an optional sub-part describing the state-of-the-art of such functionality or its use in other tools.
| <!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
| <!--- Could be screenshot of the feature implemented somewhere else or results/stats/poc showing the potential result --> | ||
|
|
||
| ## Proposal |
There was a problem hiding this comment.
"Proposal" shall be renamed to "Implementation" and shall be an optional part if there is no proposed implementation. Add a comment (e.g. "Describe the proposed implementation (PR, pseudo-code and/or diagrams)").
The idea is to have 2 main parts of the proposal (a functional and technical part). The optional is mandatory (and IMHO the important part) and the technical optional but is mandatory if there is an implementation proposed/an open PR.
| <!--- Current state of iTowns vs. state after implementation --> | ||
|
|
||
|
|
||
| ## Expected behavior |
There was a problem hiding this comment.
"Expected behavior" shall be renamed to "Description of the proposal" (in terms of functionnality).
| ## Potential Solutions | ||
| <!--- Things that could be done to avoid the mentioned problems --> | ||
|
|
||
| ## Identified use-cases |
There was a problem hiding this comment.
Use cases shall be on top (below or as a sub-part of "Description of the Proposal")!
This list will be updated by the assigned person given the comments on the proposal.
| <!--- Things that should be done in iTowns to implement this feature --> | ||
|
|
||
| ## Potential Problems | ||
| <!--- Things that could be problematic with this feature or its implementation --> |
There was a problem hiding this comment.
IMHO there could be multiple potential solutions/problems.
|
|
||
| ## Identified use-cases | ||
| <!--- Define in which context this feature could be useful for the user --> | ||
|
|
There was a problem hiding this comment.
If there is a proposed implementation, there should be a study of the impact (either by the person proposing or one of the maintainer) as a PR, pseudo-code and/or diagrams.
| --- | ||
|
|
||
| <!--- Provide a general summary of the proposal in the Title above --> | ||
| This issue is a **feature proposal**. Feel free to upvote (with :+1: ), comment and provide your use-cases if you're interested by this feature. |
There was a problem hiding this comment.
We should add an important notice that a proposal = one and only one feature.
AnthonyGlt
force-pushed
the
templates-update
branch
from
4b9da32
to
7edf50b
Compare
AnthonyGlt
force-pushed
the
templates-update
branch
from
7edf50b
to
f8d3d8c
Compare
2 issue templates: