Skip to content

Commit

Permalink
Text only updates to contributing guidelines, PR template, and news (#…
Browse files Browse the repository at this point in the history
…562)

* updates to CONTRIBUTING and PULL_REQUEST_TEMPLATE
* overdue updates to NEWS.md
  • Loading branch information
kafitzgerald authored Jun 30, 2021
1 parent 7bd095f commit d87e523
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 47 deletions.
21 changes: 10 additions & 11 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ https://help.github.com/articles/about-issues/.

### Bug reports
Please use the supplied issue template when submitting bug reports. This will help ensure that your
bug is described in sufficient detail. Additionally, you can read more on how to construct an
bug is described in sufficient detail. You can read more on how to construct an
appropriate bug report here: https://stackoverflow.com/help/mcve

### Feature requests
Expand All @@ -41,8 +41,7 @@ documentation.
All code development contributions will be made via [forks](https://help.github.com/articles/about-forks/)
and [pull requests](https://help.github.com/articles/about-pull-requests/). If you are
unfamiliar with GitHub, forks, or pull requests, see [collaborating with issues and pull
requests](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) for a
thorough guide to collaborating on GitHub.
requests](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) for guidance.

### WRF-Hydro Fortran code style standards
Please see our Fortran [code style guidelines](CODESTYLE.md)
Expand All @@ -56,7 +55,7 @@ Please see our Fortran [code style guidelines](CODESTYLE.md)
contributor to resolve any merge conflicts **prior** to submitting a pull request.
* All contributions must pass relevant automated testing procedures. These tests are executed
automatically when you submit your pull request.
* Be respectful when giving and receiving feedback on contributions or issues.
* Be respectful when giving and receiving feedback on contributions or issues (see our community [code of conduct](../CODE_OF_CONDUCT.md).

### Pull requests

Expand All @@ -82,11 +81,11 @@ which changes the answer must be isolated as much as possible into its own pull
### Types of code contributions
#### Bug fixes
All bug fixes must address a specific [GitHub
issue](https://github.com/NCAR/wrf_hydro_nwm_public/issues). Only issues labeled with "Community
dev" are open to community contributions. The majority of issues will be open to community
contributions, but some cases may require more careful handling. Issues without the "Community dev"
label are either still being investigated, are of broad scope, or involve changes to code that is
actively being developed internally.
issue](https://github.com/NCAR/wrf_hydro_nwm_public/issues). Only issues labeled with ["community
dev"](https://github.com/NCAR/wrf_hydro_nwm_public/labels/community%20dev) are open to community
contributions. The majority of issues will be open to community contributions, but some cases may
require more careful handling. Issues without the "community dev" label are either still being
investigated, are of broad scope, or involve changes to code that is actively being developed internally.

All code changes to address issues must be submitted using a pull request, and the corresponding
issue number must be referenced in the pull request. For more information on referencing issues,
Expand All @@ -96,7 +95,7 @@ see [issues and keywords](https://help.github.com/articles/closing-issues-using-
Code contributions for minor model enhancements or new features follow a similar pattern to bug
fixes. The proposed feature must be submitted as a GitHub issue and all discussions regarding the
new feature should reside in the issue thread. Additionally, work should not begin on the new
feature until the issue has been tagged with "Community dev".
feature until the issue has been tagged with "community dev".

Depending on the scope of the new feature, a WRF-Hydro core contributor may suggest you create a
[branch](https://help.github.com/articles/about-branches/) to hold all development for the new
Expand Down Expand Up @@ -143,7 +142,7 @@ case should include:
* Does no harm to the existing code (e.g., produces identical solutions EXCEPT when the new feature is
activated by a namelist or parameter setting).
* Fixes a documented issue (reference existing issue in the
[WRF-Hydro github issue tracking](https://github.com/NCAR/wrf_hydro_nwm_public/issues) - this could also be a feature request).
[WRF-Hydro GitHub issue tracking](https://github.com/NCAR/wrf_hydro_nwm_public/issues) - this could also be a feature request).
* If model performance is improved, for example through more efficient IO, memory utilization, or other
software-specific improvements, it must be demonstrable and measurable.
* *TIP*: All pull requests go through automated CI testing, but for a new feature it is important to do
Expand Down
4 changes: 3 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
If you haven't already, please review our [contributing guidelines](CONTRIBUTING.md) before opening your pull request.

Use this template to give a detailed message describing the change you want to make to the code.

The title of this pull request should be a brief "purpose" for this change.
Expand Down Expand Up @@ -31,5 +33,5 @@ on why below the bullet.
- [ ] Tests added (unit tests and/or regression/integration tests)
- [ ] Backwards compatible
- [ ] Requires new files? If so, how to generate them.
- [ ] Fully documented
- [ ] Documentation included
- [ ] Short description in the Development section of `NEWS.md`
Loading

0 comments on commit d87e523

Please sign in to comment.