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

Document processes required for PRs that change the DB structure #36

Closed
hughrun opened this issue Oct 17, 2021 · 1 comment · Fixed by #40
Closed

Document processes required for PRs that change the DB structure #36

hughrun opened this issue Oct 17, 2021 · 1 comment · Fixed by #40

Comments

@hughrun
Copy link
Contributor

hughrun commented Oct 17, 2021

In the "Developer Environment" page there's a (very helpful!) list of commands to run to set up your environment. It may be helpful to add something somewhere about what to do if your PR is going to change the database structure. This could include:

  • running docker-compose run --rm web python manage.py makemigrations before docker-compose run --rm web python manage.py migrate
  • checking in your final clean migration files
  • merging migrations if necessary
  • preferred minimum tests ("anything that posts to a model" for example)

"Developer Environment" may not be the most sensible place for this, possibly it needs its own section I'm not sure.

@mouse-reeve
Copy link
Member

I think it would make sense to add a separate section for pull requests

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 a pull request may close this issue.

2 participants