hackforla / hackforla/peopledepot

Epic: Audit differences between code and documented field names

Open
#432 67 comments 0 reactions 2 assignees Claimed by @ExperimentsInHonesty View on GitHub
complexity: large feature: ERD/SS adjustment feature: update table role: db architect role: product s: PD team size: 2pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Overview

There are field names in the code that do not currently match our documentation. We need to go through the existing django models, identify the mismatches, and update the code or documentation to comply with our desired naming conventions.

### Action Items

- [ ] List existing models
- [ ] For each model, create a table containing the different field names
- [x] https://github.com/hackforla/peopledepot/issues/472
- [ ] Verify desired naming conventions
- [ ] Update the documentation/code
- [ ] release https://github.com/hackforla/peopledepot/issues/150 from icebox

### Resources/Instructions

#### 1.01 Code locations
- 1.01.01 [/app/core/models.py](https://github.com/hackforla/peopledepot/blob/main/app/core/models.py)
- 1.01.02 [/app/core/admin.py](https://github.com/hackforla/peopledepot/blob/main/app/core/admin.py)
- 1.01.03 [/app/core/api/serializers.py](https://github.com/hackforla/peopledepot/blob/main/app/core/api/serializers.py)
- 1.01.04 [/app/core/migrations/0002_user_current_job_title_user_current_skills_and_more.py](https://github.com/hackforla/peopledepot/blob/main/app/core/migrations/0002_user_current_job_title_user_current_skills_and_more.py)

#### 1.02 [People Depot Resources wiki page](https://github.com/hackforla/peopledepot/wiki/Resources-and-Links) for links
- ERD
- Table and Field Definitions
- API Endpoint
- 1.03 Spreadsheet: [PD: Table and field explanations, Current Field Permission tab](https://docs.google.com/spreadsheets/d/1x_zZ8JLS2hO-zG0jUocOJmX16jh-DF5dccrd_OEGNZ0/edit?gid=749942651)
- [Spreadsheet, current fields in code](https://docs.google.com/spreadsheets/d/1G9kDheY3MdITZnrthTFIUyprrTEvlMYpkFYWbCAMCmA/edit?gid=2110045944#gid=2110045944)

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.