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

Update "Create Table" issue template #21

Closed
5 of 15 tasks
fyliu opened this issue Aug 9, 2022 · 0 comments · Fixed by #23
Closed
5 of 15 tasks

Update "Create Table" issue template #21

fyliu opened this issue Aug 9, 2022 · 0 comments · Fixed by #23
Assignees
Labels
complexity: missing feature: Board/GitHub repo maintenance Project board maintenance that we have to do repeatedly or automation role: missing s: PD team stakeholder: People Depot Team size: missing

Comments

@fyliu
Copy link
Member

fyliu commented Aug 9, 2022

Overview

Based on experiences from "Create Table" issues, come up with a better "Create Table" issues template

Action Items

Update the template below this line


Overview

We need to create the [name of table] table so that we can update a shared data store across hackforla.org, vrms, civictechjobs, and tables (onboarding) project.

Details

A table and a model are the same thing

Action Items

  • identify if table has a description (see spreadsheet under Resources)
    • if not, reach out to PD leads
  • identify and document (below) what the data fields are and make sure the ERD and spreadsheets match (see Resources)
  • identify and document (below) what other tables are associated and make sure the ERD and spreadsheets match (see Resources)
  • create a single model in Django (defining schema)
  • Write a test for the relationships this model will have with other models (e.g., creating a user and assigning them a set of permissions on a project).
  • Write an API end point
  • write API unit tests
  • Document the endpoint

Resources/Instructions

Items to document (referenced above)

Description

Data Fields

  1. Copied from spreadsheet and checked off according to ERD. Data fields are bolded and relation fields are not. (unchecked items indicate a mismatch between ERD and spreadsheet, which requires a review)

    • [name] - [type]
  2. In ERD only (having items here indicates a mismatch, which requires a review)

    • [name] - [type]

Associated Tables

  1. Copied from spreadsheet and checked off according to ERD (unchecked items indicate a mismatch between ERD and spreadsheet, which requires a review)

    • [other_table] ([relationship])
  2. In ERD only (having items here indicates a mismatch, which requires a review)

    • None
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: missing feature: Board/GitHub repo maintenance Project board maintenance that we have to do repeatedly or automation role: missing s: PD team stakeholder: People Depot Team size: missing
Projects
Status: ✅Done
Development

Successfully merging a pull request may close this issue.

2 participants