[Short description explaining the high-level reason for the pull request]
How does the changes affect the product?
- Code only?
- If applicable, has a deployment plan be created with the deployment person/team?
- Require new or adjusted data inputs? Does it have start, end and duration code (in UTC)?
- If new or updated data sets, has the FIM code been updated and tested with the new/adjusted data (subset is fine, but must be a subset of the new data)?
- Require new pre-clip set?
- Has new or updated python packages?
You may update this checklist before and/or after creating the PR. If you're unsure about any of them, please ask, we're here to help! These items are what we are going to look for before merging your code.
- Informative and human-readable title, using the format:
[_pt] PR: <description> - Links are provided if this PR resolves an issue, or depends on another other PR
- If submitting a PR to the
devbranch (the default branch), you have a descriptive Feature Branch name using the format:dev-<description-of-change>(e.g.dev-revise-levee-masking) - Changes are limited to a single goal (no scope creep)
- The feature branch you're submitting as a PR is up to date (merged) with the latest
devbranch -
pre-commithooks were run locally - Any change in functionality is tested
- New functions are documented (with a description, list of inputs, and expected output)
- Placeholder code is flagged / future todos are captured in comments
- CHANGELOG updated with template version number, e.g.
4.x.x.x - Add yourself as an assignee in the PR as well as the FIM Technical Lead
- Update CHANGELOG with latest version number and merge date
- Update the Citation.cff file to reflect the latest version number in the CHANGELOG
- If applicable, update README with major alterations