hackforla / hackforla/peopledepot
Create a list of things to look out for during a PR Review
- Dominant language
- Python
- Stars
- 14
- Forks
- 37
- Avg merge
- 9d 15h
- Merged PRs (30d)
- 5
Description
### 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](https://hackforla.github.io/peopledepot/contributing/howto/) 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](https://github.com/hackforla/website/wiki/How-to-review-pull-requests)
- 1.02 git
### Documentation Addition Notes
#### When would this information have been useful?
- https://github.com/hackforla/peopledepot/pull/376#pullrequestreview-2287426896
#### Which roles will benefit most from this information?
- Backend/ Dev
- DB Architect
Contributor guide
Assessment
This issue has not been assessed yet.