formatting

Author: dorotat-nv

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -14,12 +14,33 @@ body:
     id: version
     attributes:
       label: BioNeMo Framework Version
-      description: What version or commit hash of the framework are you using? Please, specify a commit hash or version tag. Do not use 'latest', 'ToT' or 'nightly' as a reference.
-        * To get the commit hash, run `git rev-parse HEAD` for your local repository or `git rev-parse origin/main` for the remote main branch.
-        * To get the commit hash from the docker image, run `docker image inspect nvcr.io/nvidia/clara/bionemo-framework:nightly --format '{{ index .Config.Labels "com.nvidia.bionemo.git_sha" }}'`.
-        * The version tag is the part that comes after the colon (:) in the docker image names available at [NGC](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/clara/containers/bionemo-framework/tags). It corresponds to the version of the framework that are tagged by `git ls-remote --tags origin`.
+      description: |
+        **What version or commit hash of the framework are you using?**
 
-      placeholder: commit-hash or version tag, ie v1.2.3.
+        Please specify a **commit hash** or **version tag**.
+        ⚠️ **Do not use** `latest`, `ToT`, or `nightly` as a reference.
+
+        **How to find the commit hash or version tag:**
+        - **Local repository commit hash:**
+          ```bash
+          git rev-parse HEAD
+          ```
+        - **Remote main branch commit hash:**
+          ```bash
+          git rev-parse origin/main
+          ```
+        - **Commit hash from a Docker image (replace `<tag>` with the version you use):**
+          ```bash
+          docker image inspect nvcr.io/nvidia/clara/bionemo-framework:<tag> \
+            --format '{{ index .Config.Labels "com.nvidia.bionemo.git_sha" }}'
+          ```
+        - **Version tag:** The part that comes after the colon (`:`) in the image name
+          (see [NGC tags](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/clara/containers/bionemo-framework/tags)).
+          You can list all remote tags with:
+          ```bash
+          git ls-remote --tags origin
+          ```
+      placeholder: commit hash or version tag, e.g. `v1.2.3`
     validations:
       required: true
 

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -19,9 +19,6 @@ body:
    attributes:
      label: BioNeMo Framework Version
      description: What version or commit hash of the framework are you using? Please, specify a commit hash or version tag. Do not use 'latest', 'ToT' or 'nightly' as a reference.
-      * To get the commit hash, run `git rev-parse HEAD` for your local repository or `git rev-parse origin/main` for the remote main branch.
-      * To get the commit hash from the docker image, run `docker image inspect nvcr.io/nvidia/clara/bionemo-framework:nightly --format '{{ index .Config.Labels "com.nvidia.bionemo.git_sha" }}'`.
-      * The version tag is the part that comes after the colon (:) in the docker image names available at [NGC](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/clara/containers/bionemo-framework/tags). It corresponds to the version of the framework that are tagged by `git ls-remote --tags origin`.
 
      placeholder: commit-hash or version tag, ie v1.2.3.
    validations: