Require a problem description in issues #14032
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently some issues are just code examples without a description **why** a change should be done. This leads to problems when (years later) the current behaviour is questioned and no one can remember why it was changed.
|
I think it may better to be added:
needs discussion though |
|
In Addition to the reason why the thing is actually a problem? |
|
See also #14031 for basically the same thing for PRs. That one also has a small example why I think such a description is needed. |
|
The addition seems fine to me. |
jreback
reviewed
Nov 16, 2016
| @@ -1,3 +1,7 @@ | |||
| #### Problem description | |||
|
|
|||
| [this should explain **why** the current behaviour is a problem and why the expected output is a better solution.] | |||
There was a problem hiding this comment.
My idea was to indicate that this text should be replaced.
|
ok, let's see how this works. thanks @JanSchulz |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently some issues are just code examples without a description why a change should be done. This leads to problems when (years later) the current behaviour is questioned and no one can remember why it was changed.