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

Add missing documentation to the PR review guide #419

Open
11 of 14 tasks
shmonks opened this issue Oct 17, 2024 · 3 comments
Open
11 of 14 tasks

Add missing documentation to the PR review guide #419

shmonks opened this issue Oct 17, 2024 · 3 comments
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it dependency Issue has dependencies feature: docs: PD team documentation documentation on PD team processes and architecture, etc. ready for dev lead ready for product role: back end role: dev role: product s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours
Milestone

Comments

@shmonks
Copy link
Member

shmonks commented Oct 17, 2024

Dependency

  • Information 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

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

Section 2: List of comments/issues about missing documentation for PR Review guide

@shmonks

This comment was marked as outdated.

@shmonks shmonks added complexity: small All steps are laid out in detail so that someone new to the project can work on it role: dev role: back end and removed points: missing complexity: missing role: missing labels Oct 24, 2024
@shmonks shmonks removed their assignment Oct 24, 2024
@shmonks shmonks added dependency Issue has dependencies and removed good first issue Good for newcomers labels Oct 25, 2024
@shmonks shmonks moved this from 🆕New Issue Review to 🧊Ice Box in P: PD: Project Board Oct 25, 2024
@ExperimentsInHonesty

This comment was marked as resolved.

@shmonks shmonks self-assigned this Oct 28, 2024
@shmonks shmonks moved this from 🧊Ice Box to 🏗In progress-actively working in P: PD: Project Board Oct 28, 2024
@shmonks shmonks added the draft This issue is not fully-written label Oct 28, 2024
@shmonks shmonks removed their assignment Oct 31, 2024
@shmonks shmonks removed the draft This issue is not fully-written label Oct 31, 2024
@shmonks shmonks moved this from 🏗In progress-actively working to 📋Prioritized Backlog in P: PD: Project Board Oct 31, 2024
@shmonks
Copy link
Member Author

shmonks commented Oct 31, 2024

Overview

We need to create a list of common things to look out for when doing a PR review, so that developers can catch things which can often be missing/wrong

Action Items

  • Create a new numbered item called 'Review a GitHub Pull Request (PR)' on this page: https://hackforla.github.io/peopledepot/contributing/howto/
  • Create a new page with that title, and add the following items under the heading 'Common things to look out for when reviewing a pull request':
    • PR destination should be peopledepot/main
    • Check model fields
    • Names should be reasonable
    • FK relations should drop the ending _id when going from DB to Django notation
    • Some fields already provided by AbstractBaseModel should not be added
  • Insert hyperlink from the numbered item on this page to the new page you created

Resources/Instructions/Tags

1.01 Example of another team's PR review guide Website team's PR review guide
1.02 git

Documentation Additional Notes

Where would this information have been useful?

Which roles will benefit most from this information?

  • Backend/Dev
  • DB Architect

@vanessaavviles vanessaavviles self-assigned this Oct 31, 2024
@vanessaavviles vanessaavviles moved this from 📋Prioritized Backlog to 🏗In progress-actively working in P: PD: Project Board Oct 31, 2024
@shmonks shmonks moved this from 🏗In progress-actively working to 🧊Ice Box in P: PD: Project Board Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it dependency Issue has dependencies feature: docs: PD team documentation documentation on PD team processes and architecture, etc. ready for dev lead ready for product role: back end role: dev role: product s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours
Projects
Status: 🧊Ice Box
Development

No branches or pull requests

3 participants