pnp
Enhancement: Enhancement template for new GitHub issues
I think it would be nice to have an extra template within our issues. One for creating new enhancement suggestions. Here all the titles and Enhancement content within the issues list would be more uniform and could possibly be automatically labeled.
What do you think @.maintainers? 😄
Sounds like a solid idea @Jwaegebaert! I don't think we should auto-label though. That's a thing we should do to have a clear point of issue-intake
Nice suggestion @Jwaegebaert, we should look to standardise where it makes sense.
Do you have a suggestion as to what you would like to include in the template or a particular format?
@garrytrinder in broad terms, I was thinking of the following subjects to include within the template.
- Version
Here they can specify the current CLI for M365 version they are using.
- Desired enhancement
This can be used to give more context about the requested functionality
- Options
This wouldn't be a required part, but here they can define the additional options that are required to fulfilll the enchancement.
- Examples
Similar to the options. When new options are suggested, it would be nice to add a few related examples of how they can be used.
Great suggestion! Maybe we could also include a section called Affected command(s)?
The main challenge with enhancements is that they vary a lot. When we come up with a template, let's see if we can apply it to some of the enhancements that we already have without replacing/removing big parts of it.
The main challenge with enhancements is that they vary a lot.
Fair point, maybe it would be beter to change the wording to e.g. Enhance command. This could then narrow it a bit more for the user and allow us to create a template with more targeted questions/forms.
Enhancements aren't just for commands though. We can have enhancements that affect the runtime or the docs.
We can have enhancements that affect the runtime or the docs.
That's true. The reason I'm giving the example of Enhance command is mainly to narrow down the enhancement template we initially had. With the example referencing the command part of the CLI, we could then also create templates for runtime enhancements and/or documentation enhancements. This way we can add several new templates but each one of them can have specific questions related towards the topic.
People can always open a blank issue so there's that and we're not taking that option away indeed. If we can have a meaningful template for enhancing existing commands, then we should definitely do it.
People can always open a blank issue
That's indeed the easiest way to create an issue. Maybe this suggestion will make it a bit to complex for users when they want to suggest enhancements.
Maybe we could create a template called Command enhancement. For other enhancements, they should open a blank issue because it will get too wide to fit into a template. Command enhancements are the most used type of enhancement I think.
Before we commit to this, could we share here an example of what would go in the template? It would make it clearer what we're looking at and help us decide if it's something we want to do or if the value add is too little to be meaningful.
Are we still interested in doing this? If not, let's close it to avoid keeping stale issues around.
Since it is difficult to agree on a template, it can be closed from me