Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Create add-missing-documentation.md #430

Merged
merged 2 commits into from
Nov 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.]