[develop]: Update PR & issue templates, Contributor's Guide (ufs-comm…

…unity#335)

* update Jenkins testing info

* minor edits

* minor updates

* minor updates to testing

* fix url, update image

* add cross reference

* minor edits

* minor fix

* condense

* expand width of docs

* update PR template

* update bug report issue file)

* update feature request template

* add areas of expertise

* Contrib Guide areas of expertise

* more expertise updates

* update PR template in Contrib Guide

* bugfix issue template updates

* update textonly issue template in CG

* PR temp updates

* add to code manager's info

* whitespace alignment

* add Labels section to PR

* update Jenkins info

* update areas of expertise


Co-authored-by: gspetro <gillian.s.petro@gmail.com>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,26 +7,38 @@ assignees: ''
 
 ---
 
-# Description
+<!-- Please remove unwanted/unrelated/irrelevant information such as comments.
+Please copy any output files into a public Github gist (see https://gist.github.com/) and link to the gist, rather than relying on paths that might change. -->
 
-Provide a clear and concise description of the bug and what behavior you are expecting.
+Your bug may already be reported!
+Please search on the [Issue tracker](https://github.com/ufs-community/ufs-srweather-app/issues) before creating a new issue. 
+If an issue already exists, please use that issue to add any additional information.
 
-## Steps to Reproduce
+## Expected behavior
+<!-- Tell us what should happen. -->
 
-Please provide detailed steps for reproducing the issue.
+## Current behavior
+<!-- Tell us what happens instead of the expected behavior. -->
 
-1. step 1
-2. step 2
-3. see the bug...
+## Machines affected
+<!--- Please provide any relevant information about your setup, including machine/compiler combination. -->
+<!-- Reference other issues or PRs in other repositories that this issue is related to, and how they are related. -->
 
-## Additional Context
+## Steps To Reproduce
+<!--- Provide a link to a live example, a code snippet, and/or an explicit set of steps to reproduce this bug.
+1. Step 1
+2. Step 2
+3. See the bug... -->
 
-Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.
+## Detailed Description of Fix (optional)
+<!--- Provide a detailed description of the change or addition you are proposing. -->
 
-* Machine
-* Compiler
-* Reference other issues or PRs in other repositories that this is related to, and how they are related.
+## Additional Information (optional)
+<!-- Any other relevant information that we should know to correctly understand and reproduce the issue. 
+Please describe in as much detail as possible. -->
 
-## Output
+## Possible Implementation (optional)
+<!--- Suggest an idea for implementing addition or change. -->
 
-Please include any relevant log files, screenshots or other output here.
+## Output (optional)
+<!-- Please include any relevant log files, screenshots or other output here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,14 +7,35 @@ assignees: ''
 
 ---
 
+<!-- Please remove unwanted/unrelated/irrelevant information such as comments.
+Please copy any output files into a public Github gist (see https://gist.github.com/) 
+and link to the gist, rather than relying on paths that might change. -->
+
+Your issue may already be reported!
+Please search on the [Issue tracker](https://github.com/ufs-community/ufs-srweather-app/issues) before creating a new issue. If an issue already exists, please use that issue to add any additional information.
+
 ## Description
-Provide a clear and concise description of the problem to be solved.
+<!-- Provide a clear and concise description of the problem to be solved. -->
+<!-- What problem needs to be fixed? -->
+<!-- What new capability needs to be added? --> 
 
 ## Solution
-Add a clear and concise description of the proposed solution.
+<!-- Add a clear and concise description of the proposed solution. -->
+
+## Requirements**
+<!-- What does the new code need to accomplish? Does it require an update 
+to a version of software (e.g. modules of NCEPLibs, NetCDF, etc.), components 
+(e.g. UFS-Weather-Model), or system tools (e.g. python3) -->
+
+## Acceptance Criteria (Definition of Done)
+<!-- What does it mean for this feature to be finished? -->
 
-## Alternatives (optional)
-If applicable, add a description of any alternative solutions or features you've considered.
+## Dependencies (optional)
+<!-- Directly reference any issues or PRs in this or other repositories that this 
+issue is related to, and describe how they are related. -->
+<!-- Does this block progress on other issues? Add this issue as a dependency to 
+other issues as appropriate e.g. #IssueNumber has a dependency on this issue -->
 
-## Related to (optional)
-Directly reference any issues or PRs in this or other repositories that this is related to, and describe how they are related.
+## Alternative Solutions (optional)
+<!-- If applicable, add a description of any alternative solutions or features 
+you've considered. -->

.github/ISSUE_TEMPLATE/textonly_request.md

@@ -8,13 +8,13 @@ assignees: ''
 ---
 
 ## Description
-Provide a clear and concise description of the problem to be solved.
+<!-- Provide a clear and concise description of the problem to be solved. -->
 
 ## Solution
-Add a clear and concise description of the proposed solution.
+<!-- Add a clear and concise description of the proposed solution. -->
 
 ## Alternatives (optional)
-If applicable, add a description of any alternative solutions or features you've considered.
+<!-- If applicable, add a description of any alternative solutions or features you've considered. -->
 
 ## Related to (optional)
-Directly reference any issues or PRs in this or other repositories that this is related to, and describe how they are related.
+<!-- Directly reference any issues or PRs in this or other repositories that this is related to, and describe how they are related. -->

.github/PULL_REQUEST_TEMPLATE

@@ -1,33 +1,91 @@
+
+- Update develop to head at ufs-community
+
 - Use this template to give a detailed message describing the change you want to make to the code.
 
-- You may delete any sections labeled "optional".
+- You may delete any sections labeled "optional" and any instructions within <!-- these sections -->.
+
+- If you are unclear on what should be written here, see https://github.com/wrf-model/WRF/wiki/Making-a-good-pull-request-message for some guidance and review the Code Contributor's Guide at https://github.com/ufs-community/ufs-srweather-app/wiki/Code-Manager's-Guide. 
 
-- If you are unclear on what should be written here, see https://github.com/wrf-model/WRF/wiki/Making-a-good-pull-request-message for some guidance. 
+- Code reviewers will assess the PR based on the criteria laid out in the Code Reviewer's Guide (https://github.com/ufs-community/ufs-srweather-app/wiki/Code-Manager's-Guide). 
 
-- The title of this pull request should be a brief summary (ideally less than 100 characters) of the changes included in this PR. Please also include the branch to which this PR is being issued.
+- The title of this pull request should be a brief summary (ideally less than 100 characters) of the changes included in this PR. Please also include the branch to which this PR is being issued (e.g., "[develop]: Updated UFS_UTILS hash").
 
 - Use the "Preview" tab to see what your PR will look like when you hit "Create pull request"
 
+
 # --- Delete this line and those above before hitting "Create pull request" ---
 
 ## DESCRIPTION OF CHANGES: 
-One or more paragraphs describing the problem, solution, and required changes.
+<!-- One or more paragraphs describing the problem, solution, and required changes. -->
+
+### Type of change
+<!-- Please delete options that are not relevant. Add an X to check off a box. -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
 
 ## TESTS CONDUCTED: 
-Explicitly state what tests were run on these changes, or if any are still pending (for README or other text-only changes, just put "None required". Make note of the compilers used, the platform/machine, and other relevant details as necessary. For more complicated changes, or those resulting in scientific changes, please be explicit!
+<!-- Explicitly state what tests were run on these changes, or if any are still pending (for README or other text-only changes, just put "None required"). Make note of the compilers used, the platform/machine, and other relevant details as necessary. For more complicated changes, or those resulting in scientific changes, please be explicit! -->
+<!-- Add an X to check off a box. -->
+
+- [ ] hera.intel
+- [ ] orion.intel
+- [ ] cheyenne.intel
+- [ ] cheyenne.gnu
+- [ ] gaea.intel
+- [ ] jet.intel
+- [ ] wcoss2.intel
+- [ ] NOAA Cloud (indicate which platform)
+- [ ] Jenkins
+- [ ] fundamental test suite
+- [ ] comprehensive tests (specify *which* if a subset was used)
 
 ## DEPENDENCIES:
-Add any links to external PRs (e.g. regional_workflow and/or UFS PRs). For example:
+<!-- Add any links to external PRs (e.g. regional_workflow and/or UFS PRs). For example:
 - ufs-community/regional_workflow/pull/<pr_number>
 - ufs-community/UFS_UTILS/pull/<pr_number>
-- ufs-community/ufs-weather-model/pull/<pr_number>
+- ufs-community/ufs-weather-model/pull/<pr_number> -->
 
 ## DOCUMENTATION:
-If this PR is contributing new capabilities that need to be documented, please also include updates to the RST files (docs/UsersGuide/source) as supporting material.
+<!-- If this PR is contributing new capabilities that need to be documented, please also include updates to the RST files (docs/UsersGuide/source) as supporting material. -->
+
+## ISSUE: 
+<!-- If this PR is resolving or referencing one or more issues, in this repository or elsewhere, list them here (Remember, issues must always be created before starting work on a PR branch!). For example, "Fixes issue mentioned in #123" or "Related to bug in https://github.com/ufs-community/other_repository/pull/63" -->
+
+## CHECKLIST
+<!-- Add an X to check off a box. -->
+- [ ] My code follows the style guidelines in the Contributor's Guide
+- [ ] I have performed a self-review of my own code using the Code Reviewer's Guide
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] My changes need updates to the documentation. I have made corresponding changes to the documentation
+- [ ] My changes do not require updates to the documentation (explain).
+- [ ] My changes generate no new warnings
+- [ ] New and existing tests pass with my changes
+- [ ] Any dependent changes have been merged and published
 
-## ISSUE (optional): 
-If this PR is resolving or referencing one or more issues, in this repository or elewhere, list them here. For example, "Fixes issue mentioned in #123" or "Related to bug in https://github.com/ufs-community/other_repository/pull/63"
+## LABELS (optional): 
+<!-- If you do not have permissions to add labels to your own PR, request that labels be added here. 
+Add an X to check off a box. Delete any unnecessary labels. -->
+A Code Manager needs to add the following labels to this PR: 
+- [ ] Work In Progress
+- [ ] bug
+- [ ] enhancement
+- [ ] documentation
+- [ ] release
+- [ ] high priority
+- [ ] run_ci
+- [ ] run_we2e_fundamental_tests
+- [ ] run_we2e_comprehensive_tests
+- [ ] Needs Cheyenne test 
+- [ ] Needs Jet test 
+- [ ] Needs Hera test 
+- [ ] Needs Orion test 
+- [ ] help wanted
 
 ## CONTRIBUTORS (optional): 
-If others have contributed to this work aside from the PR author, list them here
+<!-- If others have contributed to this work aside from the PR author, list them here -->
+
+
 

docs/UsersGuide/source/Components.rst

@@ -35,7 +35,10 @@ The prognostic atmospheric model in the UFS SRW Application is the Finite-Volume
 
 Supported model resolutions in this release include 3-, 13-, and 25-km predefined contiguous U.S. (:term:`CONUS`) domains, each with 127 vertical levels. Preliminary tools for users to define their own domain are also available in the release with full, formal support of these tools to be provided in future releases. The Extended Schmidt Gnomonic (ESG) grid is used with the FV3-LAM, which features relatively uniform grid cells across the entirety of the domain. Additional information about the FV3 dynamical core can be found in the `scientific documentation <https://repository.library.noaa.gov/view/noaa/30725>`__, the `technical documentation <https://noaa-emc.github.io/FV3_Dycore_ufs-v2.0.0/html/index.html>`__, and on the `NOAA Geophysical Fluid Dynamics Laboratory website <https://www.gfdl.noaa.gov/fv3/>`__.
 
-Interoperable atmospheric physics, along with various land surface model options, are supported through the Common Community Physics Package (CCPP), described `here <https://dtcenter.org/community-code/common-community-physics-package-ccpp>`__. Atmospheric physics are a set of numerical methods describing small-scale processes such as clouds, turbulence, radiation, and their interactions. There will be four physics suites supported for the SRW App v2.0.0 release. The first is the FV3_RRFS_v1beta physics suite, which is being tested for use in the future operational implementation of the Rapid Refresh Forecast System (RRFS) planned for 2023-2024, and the second is an updated version of the physics suite used in the operational Global Forecast System (GFS) v16. Additionally, FV3_WoFS and FV3_HRRR will be supported. A scientific description of the CCPP parameterizations and suites can be found in the `CCPP Scientific Documentation <https://dtcenter.ucar.edu/GMTB/v6.0.0/sci_doc/index.html>`__, and CCPP technical aspects are described in the `CCPP Technical Documentation <https://ccpp-techdoc.readthedocs.io/en/latest/>`__. The model namelist has many settings beyond the physics options that can optimize various aspects of the model for use with each of the supported suites. Additional information on Stochastic Physics options is available `here <https://stochastic-physics.readthedocs.io/en/release-public-v3/>`__.
+Interoperable atmospheric physics, along with various land surface model options, are supported through the Common Community Physics Package (CCPP), described `here <https://dtcenter.org/community-code/common-community-physics-package-ccpp>`__. Atmospheric physics are a set of numerical methods describing small-scale processes such as clouds, turbulence, radiation, and their interactions. There will be four physics suites supported for the SRW App v2.0.0 release. The first is the FV3_RRFS_v1beta physics suite, which is being tested for use in the future operational implementation of the Rapid Refresh Forecast System (RRFS) planned for 2023-2024, and the second is an updated version of the physics suite used in the operational Global Forecast System (GFS) v16. Additionally, FV3_WoFS_v0 and FV3_HRRR will be supported. A scientific description of the CCPP parameterizations and suites can be found in the `CCPP Scientific Documentation <https://dtcenter.ucar.edu/GMTB/v6.0.0/sci_doc/index.html>`__, and CCPP technical aspects are described in the `CCPP Technical Documentation <https://ccpp-techdoc.readthedocs.io/en/latest/>`__. The model namelist has many settings beyond the physics options that can optimize various aspects of the model for use with each of the supported suites. Additional information on Stochastic Physics options is available `here <https://stochastic-physics.readthedocs.io/en/release-public-v3/>`__.
+
+.. note::
+   SPP is currently only available for specific physics schemes used in the RAP/HRRR physics suite. Users need to be aware of which physics suite definition file (:term:`SDF`) is chosen when turning this option on. Among the supported physics suites, the full set of parameterizations can only be used with the ``FV3_HRRR`` option for ``CCPP_PHYS_SUITE``.
 
 The SRW App supports the use of both :term:`GRIB2` and :term:`NEMSIO` input data. The UFS Weather Model ingests initial and lateral boundary condition files produced by :term:`chgres_cube` and outputs files in netCDF format on a specific projection (e.g., Lambert Conformal) in the horizontal direction and model levels in the vertical direction.