Merge pull request #9 from szmazurek/pr_template_update

Correcting PR template
mlcommons · Oct 18, 2024 · bd42754 · bd42754
2 parents 5642b51 + a1d64ad
commit bd42754
Showing 1 changed file with 6 additions and 7 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -14,13 +14,12 @@ but PRs are more likely to be merged quickly if all the tasks are done. -->
 Note that if a box is left unchecked, PR merges will take longer than usual.
 -->
 - [ ] Tests have been run (`pytest --cov=. --cov-report=xml`) and the result (`coverage report -m`) has been pasted here for reviewers.
-- [ ] [`CONTRIBUTING`](https://github.com/mlcommons/GaNDLF/blob/master/CONTRIBUTING.md) guide has been followed.
-- [ ] PR is based on the [current GaNDLF master ](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch-in-github-desktop?platform=windows).
+- [ ] [`CONTRIBUTING`](https://github.com/mlcommons/GaNDLF-Synth/blob/main/CONTRIBUTING.md) guide has been followed.
+- [ ] PR is based on the [current GaNDLF-Synth main branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch-in-github-desktop?platform=windows).
 - [ ] Non-breaking change (does **not** break existing functionality): provide **as many** details as possible for _any_ breaking change.
 - [ ] Function/class source code documentation added/updated (ensure `typing` is used to provide type hints, including and not limited to using `Optional` if a variable has a pre-defined value).
 - [ ] Code has been [blacked](https://github.com/psf/black#usage) for style consistency and linting.
-- [ ] If applicable, version information [has been updated in GANDLF/version.py](https://github.com/mlcommons/GaNDLF/blob/master/GANDLF/version.py).
-- [ ] If adding a git submodule, add to list of exceptions for black styling in [pyproject.toml](https://github.com/mlcommons/GaNDLF/blob/master/pyproject.toml) file.
-- [ ] [Usage documentation](https://github.com/mlcommons/GaNDLF/blob/master/docs) has been updated, if appropriate.
-- [ ] Tests added or modified to [cover the changes](https://app.codecov.io/gh/mlcommons/GaNDLF); if coverage is reduced, please give explanation.
-- [ ] If customized dependency installation is required (i.e., a separate `pip install` step is needed for PR to be functional), please ensure it is reflected in all the files that control the CI, namely: [python-test.yml](https://github.com/mlcommons/GaNDLF/blob/master/.github/workflows/python-test.yml), and all docker files [[1](https://github.com/mlcommons/GaNDLF/blob/master/Dockerfile-CPU),[2](https://github.com/mlcommons/GaNDLF/blob/devcontainer_build_fix/Dockerfile-CUDA11.6),[3](https://github.com/mlcommons/GaNDLF/blob/master/Dockerfile-ROCm)].
+- [ ] If applicable, version information [has been updated in GANDLF/version.py](https://github.com/mlcommons/GaNDLF-Synth/blob/main/GANDLF/version.py).
+- [ ] If adding a git submodule, add to list of exceptions for black styling in [pyproject.toml](https://github.com/mlcommons/GaNDLF-Synth/blob/main/pyproject.toml) file.
+- [ ] [Usage documentation](https://github.com/mlcommons/GaNDLF-Synth/blob/main/docs) has been updated, if appropriate.
+- [ ] If customized dependency installation is required (i.e., a separate `pip install` step is needed for PR to be functional), please ensure it is reflected in all the files that control the CI, namely: [python-test.yml](https://github.com/mlcommons/GaNDLF-Synth/blob/main/.github/workflows/python-test.yml).