update markdown files for commit policy and ci #1449
Conversation
CI.md
Outdated
|
|
||
| This runs on an intel-hosted container image from dockerhub. | ||
|
|
||
| To access the netcdf and libyaml the dependencies, it builds and caches the resulting libaries for reuse. |
There was a problem hiding this comment.
the seems out of place here.
There was a problem hiding this comment.
The second "the".
To access the netcdf and libyaml the dependencies
CI.md
Outdated
| cmake v3.22.0 | ||
|
|
||
| container hosted at [noaagfdl/ubuntu_libfms_gnu:latest](https://hub.docker.com/r/noaagfdl/ubuntu_libfms_gnu) | ||
| This uses the same image as the GNU autotools CI. |
There was a problem hiding this comment.
I'm assuming you mean same container image here.
CONTRIBUTING.md
Outdated
| ## Tests | ||
|
|
||
| FMS uses TravisCI and gitlab-CI to run build tests for libFMS. Users may create | ||
| FMS uses github actions workflows to run build, runtime, and code linting tests for libFMS. Users may create |
There was a problem hiding this comment.
Perhaps "may be required to" because it really depends on the contribution. If something already has a test, then the developer won't be required to add one.
CONTRIBUTING.md
Outdated
|
|
||
| FMS pull requests are typically ‘squashed’ into one commit. | ||
| Descriptive commit messages within PR’s should still be used, and some projects / developers may find it useful to include the file and routine being updated for easy reference. | ||
| The commit message on the main branch must follow the guidelines of conventional commits, meaning it includes a ‘type’ prefix (ie. usually fix or feat(ure)) and a footer for any API-breaking changes. |
There was a problem hiding this comment.
Can you add the link to the conventional commits here?
CONTRIBUTING.md
Outdated
| ## Tests | ||
|
|
||
| FMS uses TravisCI and gitlab-CI to run build tests for libFMS. Users may create | ||
| FMS uses github actions workflows to run build, runtime, and code linting tests for libFMS. Users may create |
There was a problem hiding this comment.
Perhaps "may be required to" because it really depends on the contribution. If something already has a test, then the developer won't be required to add one.
Description
updates for the markdown files
How Has This Been Tested?
docs
Checklist:
make distcheckpasses