Skip to content

Commit

Permalink
Add HAFS governance documents (#84)
Browse files Browse the repository at this point in the history
This PR adds several files that will help with the repository governance:

*Issue templates for feature requests and bug reports. The developer will automatically be given the choice to fill out one of these templates when they try to open an issue.
*A pull request template that will automatically appear when a developer tries to open a PR.
*A CODEOWNERS file that will automatically tag Bin, Evan, Zhan, and Kathryn as default reviewers for PRs. The developer will still be able to modify the reviewers as appropriate.
*An updated README file that points developers to the HAFS code repository governance if they have questions about how to contribute.

Contributor: @evankalina
  • Loading branch information
evankalina authored Aug 9, 2021
1 parent d5b22e7 commit da78d4d
Show file tree
Hide file tree
Showing 5 changed files with 119 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in the repo.
# This can be made specific to each branch simply by designating different
# code owners in this file in different branches.
* @BinLiu-NOAA @evankalina @ZhanZhang-NOAA @KathrynNewman

# Order is important. The last matching pattern has the most precedence.
# So if a pull request only touches javascript files, only these owners
# will be requested to review.
#*.js @octocat @github/js

# You can also use email addresses if you prefer.
#docs/* [email protected]

# In this example, @doctocat owns any files in the build/logs
# directory at the root of the repository and any of its
# subdirectories.
# /build/logs/ @doctocat

# The `docs/*` pattern will match files like
# `docs/getting-started.md` but not further nested files like
# `docs/build-app/troubleshooting.md`.
# docs/* [email protected]

# In this example, @octocat owns any file in an apps directory
# anywhere in your repository.
# apps/ @octocat

# In this example, @doctocat owns any file in the `/docs`
# directory in the root of your repository and any of its
# subdirectories.
# /docs/ @doctocat
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Let us know that something is broken
title: ''
labels: ''
assignees: ''

---

## Description
Provide a clear and concise description of the bug. What is the expected (i.e., correct) behavior?

## Steps to reproduce
If someone unfamiliar with the bug follows these steps:
1. step one
2. step two
3. ...
4. eww, it's a bug!

## Additional context
Please provide any relevant information about your setup. This is important in case the issue is not reproducible except under certain conditions.

Potentially relevant details could include:
-Machine
-Physics suite or scheme
-Whether vortex relocation, data assimilation (if so, what kind?), regional versus global-nesting configuration, etc, is used.
-Reference other issues or PRs in other repositories that this is related to, and how they are related.

## Output
-Please include any relevant log files, screenshots or other output here.
-If you are using a NOAA or NCAR machine, HAFS code and experiment output directories that illustrate the bug (note the machine) are especially encouraged. Please make sure read permission is enabled.

## Status
Is someone working on this bug now? If so, please assign them to this bug report.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for HAFS
title: ''
labels: ''
assignees: ''

---

## Description
Provide a clear and concise description of the missing feature.

## Proposed solution
How should the new feature be added? If you have thoughts on the implementation strategy, please share them here.

## Status
Are you (or a colleague) working on adding this feature? If so, please assign yourself (or them) to this issue.

## Related to
Directly reference any issues or PRs in this or other repositories that this is related to, and describe how they are related. Example:

required to support hafs-community/GSI/issues/<issue_number>
needed by hafs-community/ufs-weather-model/pull/<pr_number>
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Description of changes
Provide a description of what this PR does. What bug does it fix, or what feature does it add? Do you expect that this PR will change answers, and if so, under what circumstances? If this PR is for a physics innovation, please provide references to any relevant scientific papers.

## Issues addressed (optional)
If this PR addresses one or more issues, please provide link(s) to the issue(s) here.

## Dependencies
If submodule PRs are required, please link them below. For example:
- hafs-community/ufs-weather-model/pull/<pr_number>
- hafs-community/GSI/pull/<pr_number>
- hafs-community/ccpp-physics/pull/<pr_number>

## Contributors (optional)
If others worked on this PR besides the author, please include their user names here (using @Mention).

## Tests conducted
What testing has been conducted on the PR thus far? Describe the nature of any scientific or technical tests, including relevant details about the configuration(s) (e.g., cold versus warm start, number of cycles, forecast length, whether data assimilation was performed, etc). What platform(s) were used for testing?

## Application-level regression test status
Running the HAFS application-level regression tests is currently performed by code reviewers after the developer creates the initial PR. As regression tests are conducted, the testers should use the checklist below to indicate **successful** regression tests. You may add other tests as needed. If a test fails, do not check the box. Instead, describe the failure in the PR comments, noting the platform where the test failed.

- [ ] Jet
- [ ] Hera
- [ ] Orion
- [ ] WCOSS Dell P3
- [ ] WCOSS Cray
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Hurricane Analysis and Forecast System (HAFS), as a Unified Forecast System (UFS) application, is the FV3 (Finite­ Volume Cubed-Sphere Dynamical Core) based multi-scale model and data assimilation system capable of providing tropical cyclone (TC, including hurricane and typhoon) analyses and forecasts of the inner core structure key to improving size and intensity predictions, as well as the large-scale environment that is known to influence the TC’s motion. HAFS development targets an operational analysis and forecast system for hurricane forecasters with reliable, robust and skillful guidance on TC track and intensity (including rapid intensification), storm size, genesis, storm surge, rainfall and tornadoes associated with TCs. It will provide an advanced analysis and forecast system for cutting-edge research on modeling, physics, data assimilation, and coupling to earth system components for high-resolution TC predictions within the outlined Next Generation Global Prediction System (NGGPS)/Strategic Implementation Plan (SIP) objectives of the Unified Forecast System (UFS). Currently, HAFS is under active development with collaborative efforts among NCEP/EMC, AOML/HRD, GFDL, ESRL/GSD, ESRL/NESII, OFCM/AOC, and NCAR/DTC.

For information about how to contribute to HAFS development, please review the [code repository governance](https://github.com/hafs-community/HAFS/wiki/HAFS-Code-Repository-Governance).

# Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.

0 comments on commit da78d4d

Please sign in to comment.