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

Create a new issue template for updating schemas #435

Closed
2 tasks
ExperimentsInHonesty opened this issue Nov 11, 2024 · 2 comments
Closed
2 tasks

Create a new issue template for updating schemas #435

ExperimentsInHonesty opened this issue Nov 11, 2024 · 2 comments
Assignees
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: Board/GitHub repo maintenance Project board maintenance that we have to do repeatedly or automation role: db architect s: CTJ stakeholder: Civic Tech Jobs s: kb stakeholder: knowledgebase s: tables s: VRMS stakeholder: VRMS size: 0.25pt Can be done in 0.5-1.5 hours

Comments

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Nov 11, 2024

Overview

We need to create an issue template to update the ERD and spreadsheet with the latest changes to a model, so that the three items (model, spreadsheet and ERD) are consistent

Details

Any issues this template creates will be completed after model update issue and will be dependent on it.

Action Items

  • Draft a template in a comment
  • review with product

Resources/Instructions

@ExperimentsInHonesty
Copy link
Member Author

ExperimentsInHonesty commented Nov 11, 2024

Draft

Template Name

Update Schema

About

To be created alongside an "Update Table" issue

Title

Update Schema: [TABLE NAME]

Body

### Dependency
- [ ] Update Table issue: #[Replace with ISSUE NUMBER]

### Overview
Changes need to be made to the spreadsheet and the ERD to reflect the changes made to the [TABLE NAME] model (code), so that all three can be consistent.

### Action Items
- Make changes listed below in the ERD (can be done before or after code updates)
   - [ ] Fields have been removed (if needed)
   - [ ] Fields have been added (if needed)
   - [ ] Fields have been Updated (if needed)
   - [ ] Additional schema changes have been made (if needed)
- (after the code has been changed) Make changes to spreadsheet so that the following columns are all the same (this should make the value in "Is the code the same as the plan?" have the value of TRUE
   - [ ] Called in code
   - [ ] New Field Name
   - [ ] Field Name 

### Changes Needed
#### Fields to Remove
- [ ] Any fields that need to be deleted go here. Remove this section if unused

#### Fields to Update
Any existing columns that need to be changed are added to the table below (ex: name changes, type changes). Remove this section if unused

#### Fields to Add
- [ ] Any fields that need to be added go here. Remove this section if unused


#### Additional Changes
- List any changes that are not field changes here (ex: relationship changes, table name changes, additional information added to the ERD). Remove this section if unused

### Resources
- [Entity Relationship Diagram (ERD)](https://lucid.app/lucidchart/ac2f3e81-00d2-4257-b1fc-266d7f0a4cbe/view)
- [PD: Table and field explanations, Field Permissions](https://docs.google.com/spreadsheets/d/1x_zZ8JLS2hO-zG0jUocOJmX16jh-DF5dccrd_OEGNZ0/edit?gid=371053454#gid=371053454)

@vanessaavviles vanessaavviles added complexity: large Many parts are unexplained and up to the implementer to figure out. feature: DB design role: db architect s: tables role: back end s: CTJ stakeholder: Civic Tech Jobs s: VRMS stakeholder: VRMS s: kb stakeholder: knowledgebase complexity: small All steps are laid out in detail so that someone new to the project can work on it size: 0.25pt Can be done in 0.5-1.5 hours and removed feature: DB design role: db architect complexity: large Many parts are unexplained and up to the implementer to figure out. complexity: missing size: missing stakeholder: missing milestone: missing labels Nov 11, 2024
@ExperimentsInHonesty ExperimentsInHonesty added role: db architect feature: Board/GitHub repo maintenance Project board maintenance that we have to do repeatedly or automation and removed feature: missing labels Nov 12, 2024
@ExperimentsInHonesty
Copy link
Member Author

@github-project-automation github-project-automation bot moved this from 🆕New Issue Review to ✅Done in P: PD: Project Board Nov 12, 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 feature: Board/GitHub repo maintenance Project board maintenance that we have to do repeatedly or automation role: db architect s: CTJ stakeholder: Civic Tech Jobs s: kb stakeholder: knowledgebase s: tables s: VRMS stakeholder: VRMS size: 0.25pt Can be done in 0.5-1.5 hours
Projects
Status: ✅Done
Development

No branches or pull requests

3 participants