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 database relationship diagram #1144

Merged
merged 5 commits into from
Jan 15, 2025
Merged

Update database relationship diagram #1144

merged 5 commits into from
Jan 15, 2025

Conversation

michplunkett
Copy link
Collaborator

@michplunkett michplunkett commented Jan 15, 2025

Description of Changes

Updated the database relationship diagram to match the current state of the application and added a note to the pull_request_template.md file to make sure it's updated if any changes are made to the database schema.

Tests and Linting

  • This branch is up-to-date with the develop branch.
  • pytest passes on my local development environment.
  • pre-commit passes on my local development environment.

@@ -26,5 +26,6 @@ dispatcher where…", "Improve our handling of…", etc.

## Tests and Linting
- [ ] This branch is up-to-date with the `develop` branch.
- [ ] The database diagram (`database/database_relationships.png`) has been updated if any database column have been changed, added, or dropped.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This phrasing feels clunky. I'd certainly welcome any recommendations people may have.

@@ -4,4 +4,4 @@
Running `make dev` in the docker environment will create and persist the database.

## Database Diagram
![](database_relationships.July2024.png)
![](database_relationships.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to keep some information about the last time this was updated or changed. I think keeping it in the filename is fine but open to other ways of doing it as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm working on a way to do this with a make command right now. When that's done (within a day or two), when it was last done should no longer be an issue.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fixed with this PR: #1146

@michplunkett michplunkett merged commit 88be29e into develop Jan 15, 2025
4 checks passed
@michplunkett michplunkett deleted the update-db-image branch January 15, 2025 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants