diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c6aa6ad3a..dd4ab42fc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,22 @@ ## PR Checklists (Select the checklist that applies to your PR) -Adding a Dataset Overview: +### Adding a Dataset Overview: - [ ] Dataset is available in the production VEDA STAC - [ ] Production STAC url is referenced in the dataset overview - [ ] All metadata, including those for the E&A page, is completed in the mdx file - [ ] Any images are compressed, ideally <500 KB - [ ] At least one code owner has reviewed the PR -Adding a Data Story: +### Adding a Data Story: - [ ] Any data referenced in the story is already published to VEDA STAC and referenced in a separate dataset overview page (prior to merging or as part of the same PR) - [ ] All metadata is completed in the mdx file - [ ] Any images are compressed, ideally <500 KB - [ ] Published Date is as close to the actual release date as possible (work with veda-ui team to determine potential release date when story is close to ready) - [ ] At least one code owner has reviewed the PR + +### Updating VEDA-UI +- [ ] Confirmed that [updating the `veda-ui` submodule](https://github.com/NASA-IMPACT/veda-config/blob/main/docs/DEVELOPMENT.md#development) is needed. +- [ ] Ensured that the correct version of veda-ui is being used +- [ ] Reviewed the veda-ui changelogs for relevant updates +- [ ] Tested that the changes work as expected with the current instance configuration \ No newline at end of file diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index 4dd7859af..94e7e9fb9 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -7,7 +7,7 @@ You can see the version running: ./.veda/veda --info ``` -The commit you may want to pin the `veda-ui` to will depend, but to get the latest changes from the `main` branch you could do: +The commit you may want to pin the `veda-ui` to will depend, but to update veda-ui you can do: ``` # Go into the submodule cd .veda/ui @@ -15,12 +15,10 @@ cd .veda/ui # Update the submodule info git fetch -# Switch to the branch you want. -# You can also choose a specific tag. -git switch main +# Switch to the release you want. +# You can see the list of releaset on https://github.com/NASA-IMPACT/veda-ui/releases -# Get the latest changes -git pull +git checkout vx.x.x # Get back to the root directory cd -