Adds documents for guidelines on contributing #149
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates README with link to Contirubting guide
thomas-robinson
requested review from
bensonr,
rem1776,
uramirez8707 and
underwoo
|
Resolved #150 |
bensonr
reviewed
Sep 27, 2024
bensonr
approved these changes
Sep 30, 2024
| @@ -82,6 +83,12 @@ GFDL schedule that addresses the needs of the GFDL scientists. We follow the | |||
| workflow, briefly described in the [Quick Start Workflow](#quick-start-workflow) | |||
| section. | |||
|
|
|||
| Any changes that are required for a PR in the FMScoupler should be linked. Merges | |||
| should take place downstream first in order to ensure new dependencies are | |||
| available. Changes made to componenet models that change calls in the | |||
rem1776
reviewed
Sep 30, 2024
| - Complexity | ||
| - Are the changes easily understood by the reader / reviewer? | ||
| - Testing | ||
| - Code changes should include a test program or a modification to a test program to ensure the code is covered by the test suite |
There was a problem hiding this comment.
We don't have a test suite for the coupler so should we take this out?
| unit tests, code coverage tests, and regression tests for new and existing code | ||
| in yaml (.yml) files. Github provides a guide | ||
| (https://help.github.com/en/articles/about-continuous-integration) for | ||
| implementing CI tests. |
There was a problem hiding this comment.
Might be good to mention the null_model script in this section, since thats the only real test we use in this repository besides our alpha/beta testing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the instructions for contributing to coupler including a contribution guide, a code style guide, and a code of conduct with expected behavior. There is also a link to the contribution guide at the top of the README so people will see it immediately when they visit the main page of this repo.