From 6a395ef8bbe5601706e1f4b1e4b9f21e1c86e0c8 Mon Sep 17 00:00:00 2001 From: "Sarah Monks, PhD" <141967111+shmonks@users.noreply.github.com> Date: Wed, 6 Nov 2024 14:42:58 -0800 Subject: [PATCH 1/2] Create add-missing-documentation.md New issue template for team members who find that our repo lacks sufficient information on a topic which might be necessary/useful for developers working on/with PeopleDepot --- .../add-missing-documentation.md | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/add-missing-documentation.md diff --git a/.github/ISSUE_TEMPLATE/add-missing-documentation.md b/.github/ISSUE_TEMPLATE/add-missing-documentation.md new file mode 100644 index 00000000..4acb1df1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/add-missing-documentation.md @@ -0,0 +1,31 @@ +--- +name: Add missing documentation +about: Is our repo missing documentation? Record it here so that it can be added +title: 'Add missing documentation about [REPLACE WITH TOPIC OF MISSING DOCUMENTATION]' +labels: 'complexity: missing, feature: docs: PD team documentation, milestone: missing, role: missing, + size: missing, s: PD team' +assignees: '' + +--- + +### Overview +We are striving to write documentation that helps developers on our team and our stakeholders' teams work smoothly and successfully. + +We need to add [REPLACE WITH WHAT NEEDS ADDING], so that developers can [REPLACE WITH BENEFIT] + +### Documentation Notes +#### What's missing? +- [REPLACE WITH DESCRIPTION OF WHAT'S MISSING FROM THE DOCUMENTATION] + +#### Where would this information have been useful? +- [REPLACE WITH LINK TO THE PR/ISSUE/SITUATION THAT PROMPTED THE NEED FOR THIS CHANGE/ADDITION] + +#### Which roles will benefit most from this information? +- [REPLACE WITH ROLES] + +### Action Items +- [ ] [REPLACE WITH ACTION ITEMS] + +### Resources/Instructions/Tags +- 1.01 [REPLACE WITH LINKS TO ANY EXTERNAL DOCS THAT MIGHT BE USEFUL (WITH INSTRUCTIONS, IF NEEDED)] +- 1.0x [REPLACE WITH ANY RELEVANT TAGS e.g., git, django, etc.] From 439d479fbf6c92c51831f80eca60fcae7b66fccb Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 6 Nov 2024 22:51:49 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .github/ISSUE_TEMPLATE/add-missing-documentation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/add-missing-documentation.md b/.github/ISSUE_TEMPLATE/add-missing-documentation.md index 4acb1df1..599b9e3a 100644 --- a/.github/ISSUE_TEMPLATE/add-missing-documentation.md +++ b/.github/ISSUE_TEMPLATE/add-missing-documentation.md @@ -9,23 +9,23 @@ assignees: '' --- ### Overview -We are striving to write documentation that helps developers on our team and our stakeholders' teams work smoothly and successfully. +We are striving to write documentation that helps developers on our team and our stakeholders' teams work smoothly and successfully. We need to add [REPLACE WITH WHAT NEEDS ADDING], so that developers can [REPLACE WITH BENEFIT] ### Documentation Notes #### What's missing? - [REPLACE WITH DESCRIPTION OF WHAT'S MISSING FROM THE DOCUMENTATION] - + #### Where would this information have been useful? - [REPLACE WITH LINK TO THE PR/ISSUE/SITUATION THAT PROMPTED THE NEED FOR THIS CHANGE/ADDITION] - + #### Which roles will benefit most from this information? - [REPLACE WITH ROLES] ### Action Items - [ ] [REPLACE WITH ACTION ITEMS] -### Resources/Instructions/Tags +### Resources/Instructions/Tags - 1.01 [REPLACE WITH LINKS TO ANY EXTERNAL DOCS THAT MIGHT BE USEFUL (WITH INSTRUCTIONS, IF NEEDED)] - 1.0x [REPLACE WITH ANY RELEVANT TAGS e.g., git, django, etc.]