Is your feature request related to a problem? Please describe.
We have developed a practice on our team of using the vague term "Polish" to signify cleaning up and finishing a notebook before publishing/ promoting beyond github. We would like to have a more well defined and shared definition (checklist) of what is entailed in finalizing a notebook. We would also like to include this as a PR template in the project template repo here, so that it gets propagated to all projects in a functional (non-documentation) format.
Describe the solution you'd like
Adding a PULL_REQUEST_TEMPLATE directory to .github and adding the existing PR template along with a new template for polishing notebooks. This also requires the new template be written.
Describe alternatives you've considered
Other alternative would be to keep this information as documentation, which may or may not get acted on.
While writing this issue, it seems like having this as an issue template might be another possibility.
MichaelClifford
commented
3 years ago
Is your feature request related to a problem? Please describe.
We have developed a practice on our team of using the vague term "Polish" to signify cleaning up and finishing a notebook before publishing/ promoting beyond github. We would like to have a more well defined and shared definition (checklist) of what is entailed in finalizing a notebook. We would also like to include this as a PR template in the project template repo here, so that it gets propagated to all projects in a functional (non-documentation) format.
Describe the solution you'd like
Adding a
PULL_REQUEST_TEMPLATEdirectory to.githuband adding the existing PR template along with a new template for polishing notebooks. This also requires the new template be written.Describe alternatives you've considered
Other alternative would be to keep this information as documentation, which may or may not get acted on.
While writing this issue, it seems like having this as an issue template might be another possibility.
Additional context
Here is a github blog article describing how to set up PR templates.