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

Add README to models and migrations folders #605

Merged
merged 3 commits into from
Dec 19, 2023
Merged

Conversation

Cruikshanks
Copy link
Member

Having just completed a refactoring of our models it is no longer as clear as it used to be where they are sourced from. We're also now starting to mix up models based on tables (ours) with those based on views (legacy).

So, we thought it a prudent idea to add a bit of documentation to provide a bit of context when it comes to the models and the migrations.

This change adds a README for each folder that will hopefully be useful for a new starter (and a reminder for those who have been around too long!)

Having just completed a refactoring of our models it is no longer as clear as it used to be where they are source from. We're also now starting to mix up models based on tables (ours) with those based on views (legacy).

So, we thought it a prudent idea to add a bit of documentation to provide a bit of context when it comes to the models and the migrations.

This change adds a README for each folder that will hopefully be useful for a new starter (and a reminder for those who have been around too long!)
@Cruikshanks Cruikshanks added the documentation Improvements or additions to documentation label Dec 18, 2023
@Cruikshanks Cruikshanks self-assigned this Dec 18, 2023
@Cruikshanks Cruikshanks marked this pull request as ready for review December 19, 2023 08:28
Copy link
Contributor

@Jozzey Jozzey left a comment

Choose a reason for hiding this comment

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

@Cruikshanks Cruikshanks merged commit 7a6e125 into main Dec 19, 2023
6 checks passed
@Cruikshanks Cruikshanks deleted the add-db-read-mes branch December 19, 2023 13:31
Demwunz pushed a commit that referenced this pull request Dec 20, 2023
Having just completed a refactoring of our models it is no longer as clear as it used to be where they are sourced from. We're also now starting to mix up models based on tables (ours) with those based on views (legacy).

So, we thought it a prudent idea to add a bit of documentation to provide a bit of context when it comes to the models and the migrations.

This change adds a README for each folder that will hopefully be useful for a new starter (and a reminder for those who have been around too long!)
Demwunz pushed a commit that referenced this pull request Dec 20, 2023
Having just completed a refactoring of our models it is no longer as clear as it used to be where they are sourced from. We're also now starting to mix up models based on tables (ours) with those based on views (legacy).

So, we thought it a prudent idea to add a bit of documentation to provide a bit of context when it comes to the models and the migrations.

This change adds a README for each folder that will hopefully be useful for a new starter (and a reminder for those who have been around too long!)
Demwunz pushed a commit that referenced this pull request Dec 20, 2023
Having just completed a refactoring of our models it is no longer as clear as it used to be where they are sourced from. We're also now starting to mix up models based on tables (ours) with those based on views (legacy).

So, we thought it a prudent idea to add a bit of documentation to provide a bit of context when it comes to the models and the migrations.

This change adds a README for each folder that will hopefully be useful for a new starter (and a reminder for those who have been around too long!)
Demwunz pushed a commit that referenced this pull request Dec 20, 2023
Having just completed a refactoring of our models it is no longer as clear as it used to be where they are sourced from. We're also now starting to mix up models based on tables (ours) with those based on views (legacy).

So, we thought it a prudent idea to add a bit of documentation to provide a bit of context when it comes to the models and the migrations.

This change adds a README for each folder that will hopefully be useful for a new starter (and a reminder for those who have been around too long!)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants