Skip to content

Commit

Permalink
Create add-missing-documentation.md (hackforla#430)
Browse files Browse the repository at this point in the history
* 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

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
2 people authored and fyliu committed Nov 12, 2024
1 parent d7ec7c3 commit 2b81e8b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/add-missing-documentation.md
Original file line number Diff line number Diff line change
@@ -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.]

0 comments on commit 2b81e8b

Please sign in to comment.