Entity-Relationship Diagram (ERD) generation instructions#725
Entity-Relationship Diagram (ERD) generation instructions#725adrian-rpf merged 5 commits intomainfrom
Conversation
…hip Diagram (ERD)
|
We require contributors to sign our Contributor License Agreement, and we don't have you on file. In order for us to review and merge your code, please complete this form and we'll get you added and review your contribution as soon as possible. |
Test coverage89.56% line coverage reported by SimpleCov. |
There was a problem hiding this comment.
Pull request overview
Adds documentation and configuration to support regenerating an up-to-date ERD for the Rails database schema, while removing the previously committed (and now out-of-date) generated PDF artifact.
Changes:
- Documented the workflow for generating an ERD from within the Docker Compose environment and copying it out of the container.
- Added a
.erdconfigto set a clearer ERD output filename/title. - Removed the outdated committed
erd.pdf.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds step-by-step ERD generation/copy instructions for developers using Docker Compose. |
| .erdconfig | Configures rails-erd output filename/title so regenerated diagrams are consistently named. |
| erd.pdf | Deletes the previously committed ERD PDF to avoid stale documentation artifacts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
We require contributors to sign our Contributor License Agreement, and we don't have you on file. In order for us to review and merge your code, please complete this form and we'll get you added and review your contribution as soon as possible. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
We require contributors to sign our Contributor License Agreement, and we don't have you on file. In order for us to review and merge your code, please complete this form and we'll get you added and review your contribution as soon as possible. |
|
We require contributors to sign our Contributor License Agreement, and we don't have you on file. In order for us to review and merge your code, please complete this form and we'll get you added and review your contribution as soon as possible. |
Added instructions to the README for how to generate an up-to-date Entity-Relationship Diagram (ERD). Deleted the out-of-date erd.pdf. Added a .erdconfig file to give the generated file a clearer name.