forked from ESCOMP/CTSM
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from rgknox/bchristo-planthydro-longlived
Bchristo planthydro longlived
- Loading branch information
Showing
29 changed files
with
4,770 additions
and
1,794 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
|
||
### Description: | ||
<!--- Describe your changes in detail --> | ||
<!--- please add issue number if one exists --> | ||
|
||
### Collaborators: | ||
<!--- List names of collaborators or people who have interacted --> | ||
<!--- in bringing about this set of changes --> | ||
<!--- consultation, discussions, etc. --> | ||
|
||
### Expectation of Answer Changes: | ||
<!--- Please describe under what conditions, if any, --> | ||
<!--- the model is expected to generated different answers --> | ||
<!--- from the master version of the code --> | ||
|
||
|
||
### Checklist: | ||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
- [ ] My change requires a change to the documentation. | ||
- [ ] I have updated the in-code documentation AND wiki accordingly. | ||
- [ ] I have read the [**CONTRIBUTING**](https://github.com/rgknox/fates/blob/rgknox-new-PR-template/CONTRIBUTING.md) document. | ||
- [ ] FATES PASS/FAIL regression tests were run | ||
- [ ] If answers were expected to change, evaluation was performed and provided | ||
|
||
|
||
### Test Results: | ||
<!--- Non-trivial changes require the PASS/FAIL regression tests. --> | ||
<!--- If changes to code are NOT expected to change answers, tests must --> | ||
<!--- be run against a baseline. --> | ||
|
||
FATES-CLM (or) HLM test hash-tag: | ||
|
||
FATES-CLM (or) HLM baseline hash-tag: | ||
|
||
FATES baseline hash-tag: | ||
|
||
Test Output: | ||
|
||
<!--- paste in test results here --> | ||
|
||
|
||
<!--this template is from https://www.talater.com/open-source-templates/#/page/99--> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# How to contribute | ||
|
||
Thank you for considering contributing to the development of FATES. There are a few guidelines that we need contributions to follow. | ||
|
||
## Read and Understand the FATES license: | ||
|
||
https://github.com/NGEET/fates/blob/master/LICENSE.txt | ||
|
||
## If working with unreleased code, please read the use policy that governs the developer repository: | ||
|
||
https://github.com/NGEET/fates/wiki/Use-and-distribution-policy-for-fates-developer-repository | ||
|
||
## Getting Started | ||
|
||
Those who wish to contribute code to FATES must have those changes integrated through the developer repository NGEET/fates. Changes that make it to public releases must go through this repository first, as well. Here are some basic first steps. | ||
|
||
* All developers should create a fork of the NGEET/fates repository into their personal space on github | ||
* Follow the developer work-flow described here: https://github.com/NGEET/fates/wiki/FATES-Development-Workflow | ||
* Each set of changes should have its own feature branch that encapsulates your desired changes, following the conventions outlined here: https://github.com/NGEET/fates/wiki/Feature-Branch-Naming-Convention | ||
* The work-flow will lead you eventually to submit a Pull-Request to NGEET/fates:master, please follow the template in the Pull Request and communicate as best you can if you are unsure how to fill out the text | ||
* It is best to create an issue to describe the work you are undertaking prior to starting. This helps the community sync with your efforts, prevents duplication of efforts, and science is not done in a vaccuum! | ||
* Expect peers to interact, help, discuss and eventually approve your submission (pull-request) | ||
|
||
|
||
## Things to Remember | ||
|
||
* Make commits in logical units (i.e. group changes) | ||
* Changes that are submitted should be limited to 1 single feature (i.e. don't submit changes to the radiation code and the nutrient cycle simultaneous, pick one thing) | ||
* Check for unnecessary whitespace with `git diff --check` before committing | ||
* We have no standard protocol for commit messages, but try to make them meaningful, concise and succinct. | ||
* You will most likely have to test (see workflow above), see: https://github.com/NGEET/fates/wiki/Testing-Protocols | ||
|
||
|
||
## Coding Practices and Style | ||
|
||
Please refer to the FATES style guide: https://github.com/NGEET/fates/wiki/Coding-Practices-and-Style-Guide | ||
|
||
|
||
## Trivial Changes | ||
|
||
If changes are trivial, it's possible testing will not be required. Conversations via the Pull Request will address if tests are not needed | ||
|
||
## Documentation | ||
|
||
Yes please! If you are creating new code, fixing existing code, anything. Please add comments in the code itself. Please also follow the style guide for comments. Also, please create and/or modify existing wiki documentation. You may be asked to add documtation prior to having a pull-request approved. | ||
|
||
|
||
## Additional Resources | ||
|
||
* [General GitHub documentation](https://help.github.com/) | ||
* [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/) | ||
* [FATES Wiki](https://github.com/NGEET/fates/wiki) |
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
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
Oops, something went wrong.