chore: add steps for database migrations in PRs
This commit is contained in:
parent
1e2982d9ce
commit
99713eee6a
2 changed files with 5 additions and 0 deletions
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
|
|
@ -101,6 +101,8 @@ A pull request does not necessarily need to *close* an issue. A pull request may
|
|||
|
||||
Like everything else, pull requests should be as detailed as possible. Your title should adequately summarize the changes being made, and the body of the pull request should fully explain your changes. We ask that, if applicable, the rationale behind your changes also be noted. For example rather than simply "Changed from `for...of` to `forEach`", if the change was made for a performance reason you should say "Changed from `for...of` to `forEach` due to `forEach` being X times faster in this case" and provide some benchmarks. Adding images, videos, etc. is also welcomed in order to illustrate changes. If the changes being made are directly tied to some form of visual (such as a change to the website, a tools GUI, etc.) then images or videos is ***REQUIRED***. If none are provided, then we may delay review until they are given. Providing visual examples of these changes allow us to quickly assess whether or not we wish to proceed with the changes being made.
|
||||
|
||||
If a pull request requires any database migrations, describe them in detail and leave any migration queries inside of a code block within a `<details>` tag. This should happen either at the very beginning of the pull request message, or at the very end, but not somewhere in between. Doing so makes it clear at a glance that there are migrations required and makes it easy to find the related queries.
|
||||
|
||||
We ask that you have patience with us as we review your pull request. Pretendo Network only has a single full time developer, all other work is done by volunteers on their own time. Due to the sheer number of issues and pull requests, alongside our other general work and research, it may take us some time to fully review and decide on whether or not to merge your changes.
|
||||
|
||||
# Tests
|
||||
|
|
|
|||
3
.github/PULL_REQUEST_TEMPLATE.md
vendored
3
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -13,6 +13,9 @@ Resolves #XXX
|
|||
|
||||
* Describe your changes in as much detail as possible. Make sure to list your changes, as well as the rationale behind them.
|
||||
* If applicable, include code snippets, images, videos, etc.
|
||||
*
|
||||
* If your changes require any database migrations, describe them in detail and leave any migration queries inside of a code
|
||||
* block within a <details> tag.
|
||||
|
||||
-->
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue