diff --git a/README.md b/README.md index 27177f1..6bd421b 100644 --- a/README.md +++ b/README.md @@ -66,4 +66,6 @@ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials/file All are welcome to contribute by creating a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). We try to follow the [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow) workflow. +See [PR Review](docs/pr_review.md) for more details and options on how to review a PR. + See the [developer docs](docs/developer.md) to learn more about how to add data layers and indicators. diff --git a/docs/pr_review.md b/docs/pr_review.md new file mode 100644 index 0000000..9cd4456 --- /dev/null +++ b/docs/pr_review.md @@ -0,0 +1,26 @@ +# Pull Request Review + +There are 4 options for doing code review +## Github +1. Go to https://github.com/wri/cities-cif/pulls and find the PR you want to review +2. Use Github's web based interface to review the code changes, make inline comments, and submit the review. See https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request for more details. + +NOTE: This does not allow you to run the code, so is not the prefered approach, especially for more complicated changes. + +## Colab +1. Open a new Colab notebook at https://colab.new/ +2. Install the package from the branch you want to review with `!pip install git+https://github.com/wri/cities-cif@[branch-name]` replaceing `[branch-name]` with the branch you want to review. e.g `!pip install git+https://github.com/wri/cities-cif@feature/max_dsm` for the `feature/max_dsm` branch. https://github.com/wri/cities-cif/tree/feature/max_dsm +3. Run the code to test that it works as expected +4. Use the Github PR UI (as described above) to submit your review. + +See https://drive.google.com/drive/u/0/folders/1W5VxN_7_WdjnX64SgI5SxAnJW9hhigA_ for examples + +## Codespace +In progress. + +## Local +1. Check out the branch locally +2. Run the code to test that it works as expected +3. Use the Github PR UI (as described above) to submit your review. + +