Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Link each due diligience item in PR templates to documentation #11

Open
reefdog opened this issue Jun 6, 2020 · 1 comment
Open

Link each due diligience item in PR templates to documentation #11

reefdog opened this issue Jun 6, 2020 · 1 comment

Comments

@reefdog
Copy link

reefdog commented Jun 6, 2020

Feature Request

Is your feature request related to a problem? Please describe.

Currently, our PR template contains a checklist of due diligence items. For new contributors, it may not be clear what our expectations or best practices for each item are.

Describe the solution you'd like

We should document our guidance and expectations / best practices for each of these items, and then link the checklist items to that documentation in the template.

Describe alternatives you've considered

I hadn't really considered any. I suppose there's always not doing this.

Teachability, Documentation, Adoption, Migration Strategy

We have a CONTRIBUTING file that contains some of this information already; we should at least ensure guidance for each due diligence item is expressed there, and link to it. Some items, like TESTING, may justify their own separate documentation file.

@slifty
Copy link
Member

slifty commented Jul 11, 2020

Moving this to the meta repository since our PR templates live there now!

@slifty slifty transferred this issue from tvkitchen/base Jul 11, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants