Update issue templates #9
Conversation
| * Who is affected by the change? | ||
| * Why is this a good solution? | ||
|
|
||
| **Description** |
There was a problem hiding this comment.
One thought that comes to mind: this template seems to assume that the requestor has a solution in mind. There should either be a separate template for somebody opening a request but w/ no idea how to solve it, or a hearty dose of "(if applicable)" in this template.
Looking at the work-in-progress template, I think it might be best to leave that as is, and then maybe collapse Description and Alternatives into a single section, here. Something like Possible Solutions?
There was a problem hiding this comment.
That's a good point -- a feature request doesn't need that much detail on the implementation, at least to start. Updated accordingly.
| Describe the need for the work being done: | ||
|
|
||
| * What problem is it trying to solve? | ||
| * Who is affected by the change? |
There was a problem hiding this comment.
Would an entry for "Files impacted" be worthwhile?
There was a problem hiding this comment.
We could ask for files / classes impacted, but that feels like more detail than necessary. Once people have modifications underway, I'd like them to link to the in-progress branch where they're working.
There was a problem hiding this comment.
Yes, good point. My only thought here was that it would give a way to communicate to others if the "ground beneath their feet" was about to change. i.e. if there is some major change that is going to affect files where they are currently working on changes. But agree that it might be a bit much to ask for...
|
Can you add a README that summarizes some of this as well as the point of this repo? |
| @@ -0,0 +1,28 @@ | |||
| --- | |||
| name: Feature request | |||
| about: " Suggest a new feature to enhance Cantera" | |||
There was a problem hiding this comment.
Leading space here, and does it need the quotes?
There was a problem hiding this comment.
Fixed the leading space. I'm leaving the quotes because GitHub put them there when I used their tool to create these issue templates.
|
Thanks for taking this on @speth! |
|
I think this repo is a great idea. Thanks! |
Creating issue templates to clarify the purpose of this repository and structure the contents of the submitted feature requests / work in progress reports. Based loosely on the Numpy Enhancement Proposal template.