Closed TomWFox closed 3 years ago
Thoughts @mtrezza @davimacedo?
Experiences from the parse server repo, after which this template seems to be shaped:
Sometimes the checkboxes at the top are misunderstood as "check which ones apply" instead of the intended "all are required, so make sure all are checked". That comment section of the template should therefore be rephrased to male that clear.
It still (although much rarer than pre-PR template) happens that PRs are created without corresponding issue. Issues should always be mandatory for a PR, because a low-level solution should be derived from a high level discussion, which should take place in the issue thread, not in the PR thread. This template is lacking that, but I think the server repo template has that as required checkbox.
TODOs at the bottom are repo specific and important, to reduce the risk of PRs lacking required chores. It proved to be successful with the server repo. I think at least each of the client sdk repos also should list its specific TODOs at some point, and will therefore require a specific template.
@mtrezza Thanks for your thoughts. I've move my suggestion for a PR template and your comments over to a new issue as it seems it would benefit from a broader discussion about what makes sense for a default template, or whether there should be one at all.
I've also marked the PR as ready for review as I think adding the stack overflow and forum links are a nice improvement as is.
I think the logical follow-up PRs would be to override this default in the repos for which we have specific SO tags. For example the client sdk repos, should point to their own tags on SO.
Possibly, although for Parse Server we have a link to the parse-platform tag. Maybe we could have a link with both the parse-platform tag and repo specific tag - https://stackoverflow.com/questions/tagged/parse-platform+parse-server. Only downside is that won't surface questions that only have the repo specific tag.
Edit: I noticed my suggestion is how you've already done it for the JS SDK (https://stackoverflow.com/questions/tagged/parse-platform+parse-javascript-sdk)
It seems this change hasn't worked out as intended. Although not obvious in the documentation, I think there has to be at least one issue template for the 'issue chooser' to show up - that'll be my next task!
I could also add a default bug report and feature request issue template which would work for most repos but not all. For example, it wouldn't make sense on this repo or the governance repo - most/all such repos are fairly insignificant (in terms of issues) so it could be fine.