thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
681 stars 170 forks source link

Added README template and template guide for review #248

Open fungjoanne opened 2 years ago

fungjoanne commented 2 years ago

Template quality checklist

This quality checklist will eventually become a pull request template that every contributor needs to add to pull requests against the templates repository.

Pull request summary

{Describe the purpose of your pull request.}

{Also indicate which template working group you belong to and who your template mentor is.}

Template contributor checklist

IMPORTANT: The next three sections in this checklist should be filled out by the template contributor at the time they submit this request.

NOTE: Pull requests can only be merged when all boxes are checked.

Which issue does this pull request fix or reference?

This pull request:

Procedural requirements

Template set requirements

Template pull request reviewer checklist

IMPORTANT: The rest of the sections in this checklist should only be filled out by authorized Good Docs Project pull request reviewers. If you are the individual template contributor, do not fill out the rest of the fields or check the boxes.

NOTE: Pull requests can only be merged when all boxes are checked.

Mechanics and formatting requirements - PULL REQUEST REVIEWER ONLY

Overall usability - PULL REQUEST REVIEWER ONLY

Template file requirements - PULL REQUEST REVIEWER ONLY

Template guide requirements - PULL REQUEST REVIEWER ONLY

Deep dive requirements (optional) - PULL REQUEST REVIEWER ONLY

Template example requirements (optional) - PULL REQUEST REVIEWER ONLY