Issue template for notebook updates#428
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new GitHub Issue Form template to propose updates to cookbook notebook/page content (companion to the previously added “remove notebook” template).
Changes:
- Introduces an “Update notebook” issue template with fields for target content, what’s out of date/missing, recommended updates, and context.
- Adds a “Decision” checkbox section to record the outcome before opening a PR or closing the issue.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
What do you think about changing the "Decision" section to something more informational? I'm doubtful the checkboxes will be successfully used. Checkboxes also aren't an "either-or" data field, possibly leading to some confusion with "to-do" checkboxes. How about this For the update template: For the remove template: Not sure about exact wording yet, so I didn't want to put this in as a code suggestion. |
|
I like that idea @itcarroll, it's a bit clearer. Do you think we should link to the other issue templates (i.e., if someone opens an issue to remove a notebook, but it becomes clear that just an update would be better they should open an "update" issue? |
itcarroll
left a comment
There was a problem hiding this comment.
I've gone ahead with some additional enhancements beyond the scope of the original issue for consistency.
I think we won't be able to see if this is all "working" until its merged to main. I'm available to rapidly take up fixes as needed.
ateucher
left a comment
There was a problem hiding this comment.
Thanks @itcarroll great changes! I had a two small comments, otherwise I think you can merge this. I can't approve since I'm the original PR author
An issue template for proposing notebook updates based on #425 by @mikala-nsidc. A companion to the "remove notebook" template merged in #423