hackforla / hackforla/peopledepot

Add missing documentation to the PR review guide

Open
#419 3 comments 0 reactions 0 assignees View on GitHub
complexity: small dependency feature: docs: PD team documentation PII: FALSE role: back end role: dev role: product s: PD team size: 0.25pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Dependency
- [ ] Some information is missing from the PR review guide

### Overview
We need to make it easy to:
- Record any missing documentation for the PR review guide
- Keep those records in one place
- Create new issues based on those records

This issue is the place to record missing documentation and start creating related new issues.

#### Details
- We are striving to write documentation that helps developers create and review PRs. See Resource 1.01
- This issue tracks the documentation that needs to be added to the **PR review guide.** If you've noticed missing documentation about other Git and/or Django processes,

see the following issues instead

- #421
- #422
- #423
- #424
- #425

### Action Items
- [ ] For each piece of missing information, copy and paste the following template into a new comment below.
```
### Overview
We need to add [REPLACE WITH WHAT NEEDS ADDING], so that developers can [REPLACE WITH BENEFIT]

### Action Items
- [ ] [REPLACE WITH ACTION ITEMS]

### Resources/Instructions/Tags

- 1.01 Example of another team's PR review guide [Website team's PR review guide](https://github.com/hackforla/website/wiki/How-to-review-pull-requests)
- 1.0x [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.]

### Documentation Addition Notes
#### What's missing?
[REPLACE WITH DESCRIPTION OF WHAT'S MISSING FROM THE DOCUMENTATION]

#### Where should it go?
[REPLACE WITH URL OR INDICATE NEW PAGE AND PARENT PAGE]

#### When 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]

```
- [ ] Fill out as many of the template's fields as possible.
- [ ] Copy and paste a link to your comment in **Section 2: List of comments/issues about missing documentation for PR Review guide** below, using the next available number
- [ ] Copy the content of your comment
- [ ] Create a new issue, pasting the content of your comment into the new issue
- Add the following labels to the new issue
- [ ] `feature: docs: PD team documentation`
- [ ] `size: 0.25pt`
- [ ] `s: PD team`
- [ ] `ready for dev lead`
- [ ] choose a complexity label that fits
- [ ] choose the role label that fits
- [ ] When this new issue has been created, add a link to it in **Section 2: List of comments/issues about missing documentation for PR Review guide** below. Make sure the link to your new issue appears beneath the link to your comment, so we can ensure that all comments get made into issues
- [ ] Hide the original comment (you can mark it 'Resolved')

### Resources/Instructions
- 1.01 Example of another team's PR review guide [Website team's PR review guide](https://github.com/hackforla/website/wiki/How-to-review-pull-requests)

### Section 2: List of comments/issues about missing documentation for PR Review guide
- 2.01 https://github.com/hackforla/peopledepot/issues/419#issuecomment-2450728811
- 2.01.01 #438

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.