Merge pull request #804 from sarthakpati/update_templates

Update GitHub templates

.github/ISSUE_TEMPLATE/---bug-report.md

@@ -1,39 +1,33 @@
 ---
 name: "\U0001F41B Bug Report"
 about: Help us improve our project
-title: ''
-labels: ''
-assignees: ''
+title: "[BUG] "
+labels: ""
+assignees: ""
 
 ---
 
-**Describe the bug**
+### Describe the bug
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+### To Reproduce
 Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+1. Use the data `'...'`
+2. Run command `'...'`
+3. Scroll down to `'...'`
+4. See error (it would be helpful to include the error message and stack trace)
 
-**Expected behavior**
+### Expected behavior
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+### Media
+If applicable, add images, screenshots or other relevant media to help explain your problem.
 
-**GaNDLF Version**
-<!-- Put the output of the following command:
-python -c 'import GANDLF as g;print(g.__version__)'
--->
-Version information of the GaNDLF package in the virtual environment.
-
-**Environment information:**
+### Environment information
 <!-- Put the output of the following command:
 python ./gandlf_debugInfo
 -->
-OS, hardware, and so on.
+GaNDLF version, OS, and any other relevant information.
 
-**Additional context**
+### Additional context
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/---feature-request.md

@@ -1,20 +1,20 @@
 ---
 name: "\U0001F4A1 Feature Request"
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
+title: "[FEATURE] "
+labels: ""
+assignees: ""
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+### Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. For example, it is frustrating when [...]
 
-**Describe the solution you'd like**
+### Describe the solution you'd like
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
+### Describe alternatives you've considered
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
+### Additional context
 Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/--questions-help-support.md

@@ -1,31 +1,30 @@
 ---
 name: "❓ Questions/Help/Support"
 about: Ask questions to the developers
-title: ''
-labels: ''
-assignees: ''
+title: "[QUESTION] "
+labels: ""
+assignees: ""
 
 ---
 <!-- By proceeding, you acknowledge that you have 
 taken a look at the FAQ section in the documentation:
 https://mlcommons.github.io/GaNDLF/faq
 -->
 
-**GaNDLF Version**
+### Environment information
 <!-- Put the output of the following command:
-python -c 'import GANDLF as g;print(g.__version__)'
+python ./gandlf_debugInfo
 -->
-Version information of the GaNDLF package in the virtual environment.
+GaNDLF version, OS, and any other relevant information.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. Windows/Linux (include detailed distro information)/macOS]
- - Version (including Build information, if any): [e.g. Fedora 22 or Windows 10.1803]
-
-**How did you install GaNDLF**
+### How did you install GaNDLF
 Please provide all steps followed during installation.
 
-**Dataset description**
-Describe the data (radiology/histology/so on, dimensions, etc.).
+### Dataset description
+Describe the data (radiology/histology/so on, dimensions, etc.) with as much detail as possible.
 
-**Describe your question/problem**
+### Describe your question/problem
 A clear and concise description of what issue you are facing.
+
+### Additional context
+Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,7 +2,7 @@
 Fixes #ISSUE_NUMBER
 
 ## Proposed Changes
-<!-- Bullet pointed list of changes, please try to keep code changes as small as possible-->
+<!-- Bullet pointed list of changes; **PLEASE** try to keep code changes as small as possible-->
 - 
 
 ## Checklist
@@ -13,11 +13,11 @@ but PRs are more likely to be merged quickly if all the tasks are done. -->
 <!-- Replace `[ ]` with `[x]` in all the boxes that apply.
 Note that if a box is left unchecked, PR merges will take longer than usual.
 -->
-- [ ] I have read the [`CONTRIBUTING`](https://github.com/mlcommons/GaNDLF/blob/master/CONTRIBUTING.md) guide.
-- [ ] My PR is based from 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/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).
 - [ ] 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.
-- [ ] Code has been [blacked](https://github.com/psf/black#usage) for style consistency.
+- [ ] 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.

gandlf_run

@@ -76,7 +76,6 @@ if __name__ == "__main__":
         type=ast.literal_eval,
         help="Resume previous training by only keeping model dict in 'modeldir'",
     )
-
     parser.add_argument(
         "-o",
         "--outputdir",
@@ -85,7 +84,6 @@ if __name__ == "__main__":
         type=str,
         help="Location to save the output of the inference session. Not used for training.",
     )
-
     parser.add_argument(
         "-v",
         "--version",