aicoe-aiops / project-template

this is a template to use for new data science projects in the aiops group
Other
8 stars 21 forks source link

add 'polish' PR template #32

Closed MichaelClifford closed 3 years ago

MichaelClifford commented 3 years ago

Related Issues and Dependencies

31

This introduces a breaking change

This Pull Request implements

This PR, I moved the default PR template into a new directory .git/PULL_REQUEST_TEMPLATE and renamed it SIMPLE_TEMPLATE. I also created a new template for submitting finalized notebooks POLISH_TEMPLATE. The point of these changes is to allow for multiple PR templates.

isabelizimm commented 3 years ago

I know this template is for notebooks in particular, but would it be useful to incorporate some sort of acceptance criteria on existence/grammar/spelling/standards for a README as well here?

MichaelClifford commented 3 years ago

I know this template is for notebooks in particular, but would it be useful to incorporate some sort of acceptance criteria on existence/grammar/spelling/standards for a README as well here?

@isabelizimm good point, we could probably put some standards in place for README's but lets have that as a separate issue for the moment, and keep this one on notebooks. : )