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

Doc: Add Run Migration Script instruction to README.md when new version is added to the repo. #1089

Open
3 tasks
mtreacy002 opened this issue May 2, 2021 · 2 comments
Assignees
Labels
BIT This labels issues that need to be completed to help BIT Category: Documentation/Training Improvements or additions to documentation. Type: Enhancement New feature or request.

Comments

@mtreacy002
Copy link
Member

mtreacy002 commented May 2, 2021

Description

As a contributor,
I need to add instruction on how to run migration script when a new version of migration script is added to the repo,
so that the contributors can update their db schemas when there is a schema update.

Acceptance Criteria

Update [Required]

  • add a section on Run migration script to README.md for when a new migration script is added to the repo.

Definition of Done

  • All of the required items are completed.
  • Approval by 1 mentor.

Estimation

1 hr

@mtreacy002 mtreacy002 self-assigned this May 2, 2021
@mtreacy002 mtreacy002 added BIT This labels issues that need to be completed to help BIT Category: Documentation/Training Improvements or additions to documentation. Type: Enhancement New feature or request. Type: Maintenance Repository maintenance. and removed Type: Enhancement New feature or request. Type: Maintenance Repository maintenance. labels May 2, 2021
@vj-codes
Copy link
Member

vj-codes commented May 3, 2021

@mtreacy002 hey how this different from issue #996 and PR #1038

@mtreacy002
Copy link
Member Author

🤔 , @vj-codes , I think #996 is addressing what contributors should do after they make changes to the db aka they need to create a new migration script within the PR where the db models are being changed. Whereas this issue is addressing what other contributors should do as an impact of a new migration script being merged to the repo when they pull the latest update from the repo. I will modify this issue title and description so to reflect this. Thanks for making me aware of the other issue and pr 😉 . cc @isabelcosta and @epicadk

@mtreacy002 mtreacy002 changed the title Doc: Add Run Migration Script instruction to README.md Doc: Add Run Migration Script instruction to README.md when new version is merged to the repo. May 3, 2021
@mtreacy002 mtreacy002 changed the title Doc: Add Run Migration Script instruction to README.md when new version is merged to the repo. Doc: Add Run Migration Script instruction to README.md when new version is added to the repo. May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BIT This labels issues that need to be completed to help BIT Category: Documentation/Training Improvements or additions to documentation. Type: Enhancement New feature or request.
Projects
None yet
Development

No branches or pull requests

2 participants