docs: Add a pull request template #142
Conversation
There was a problem hiding this comment.
Overall looks good. I agree, keeping things more general is a good choice. At least for now.
But I'm not sure why the commented out sections are in the template? Are they there in case we want to add something in the future? Or for the user to uncomment if/when applicble?
| <!-- If the implementation is complex, add details here. Also include any other related issues, docs, or discussions --> | ||
|
|
||
|
|
||
| <!--## Is there a breaking change introduced? --> |
There was a problem hiding this comment.
Are we wanting to leave this (and the next one) here, but commented out? Is this in case we ever want to add them? Or for the user to uncomment if/when they need these sections?
There was a problem hiding this comment.
Yeah I'm not super happy with the one I wrote here in general now I've tried it. I spent a bit too long on it so I'll put this into draft and revisit another day I think.
There was a problem hiding this comment.
Fair enough. Did you ask multiple AIs to see which one pukes out the best thing? :)
There was a problem hiding this comment.
Cheers for the approve - I'm glad that the idea is approved anyway! I'll probably change it a bit and let you know for a re look.
2 participants
What does this change do?
I've added a PR template, mainly as it seems easier than documenting it. I kind of want to try things out, and change it over time instead of trying to perfect it.
Right now I've got it with comments, but maybe empty titles is actually better.
I kind of want to avoid it being too formal like this one https://raw.githubusercontent.com/angular/angular/refs/heads/main/.github/PULL_REQUEST_TEMPLATE.md. Most templates seemed aimed at new/rare users, instead of prioritising the maintenance team
How was this tested?
NA
Other details
NA