Skip to content

Commit 27a5b40

Browse files
authored
Merge pull request #1467 from glemieux/readme-compat-update
Update README links to the user's guide
2 parents c1dfc21 + 2f6b937 commit 27a5b40

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
5353

5454
[homepage]: http://contributor-covenant.org
5555
[version]: http://contributor-covenant.org/version/1/4/
56-
[wiki_ref_page]: https://github.com/NGEET/fates/wiki/Relevant-References
56+
[references]: https://fates-users-guide.readthedocs.io/en/latest/user/Relevant-References.html

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ https://github.com/NGEET/fates/blob/master/CODE_OF_CONDUCT.md
1212

1313
## Getting Started
1414

15-
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.
15+
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. Please refer to the [developer section](hhttps://fates-users-guide.readthedocs.io/en/latest/developer/developer-guide.html) of the [User's Guide](https://fates-users-guide.readthedocs.io/en/latest/index.html) for more details. Here are some basic first steps:
1616

1717
* All developers should create a fork of the NGEET/fates repository into their personal space on github
18-
* Follow the developer work-flow described here: https://github.com/NGEET/fates/wiki/FATES-Development-Workflow
19-
* 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
18+
* Follow the [developer work-flow](https://fates-users-guide.readthedocs.io/en/latest/developer/FATES-Development-Workflow.html)
19+
* Each set of changes should have its own [feature branch](https://fates-users-guide.readthedocs.io/en/latest/developer/Feature-Branch-Naming-Convention.html) that encapsulates your desired changes.
2020
* 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
2121
* 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!
2222
* Expect peers to interact, help, discuss and eventually approve your submission (pull-request)
@@ -31,11 +31,11 @@ In addition to the github discussions, we hold a roughly biweekly call, which co
3131
* 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)
3232
* Check for unnecessary whitespace with `git diff --check` before committing
3333
* We have no standard protocol for commit messages, but try to make them meaningful, concise and succinct.
34-
* You will most likely have to test (see workflow above), see: https://github.com/NGEET/fates/wiki/Testing-Protocols
34+
* You will most likely have to test (see workflow above), see the [testing protocols](https://fates-users-guide.readthedocs.io/en/latest/developer/Testing-Protocols.html) for more details.
3535

3636
## Coding Practices and Style
3737

38-
Please refer to the FATES style guide: https://github.com/NGEET/fates/wiki/Coding-Practices-and-Style-Guide
38+
Please refer to the FATES [style guide](https://fates-users-guide.readthedocs.io/en/latest/developer/style.html)
3939

4040
## Trivial Changes
4141

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To receive email updates about forthcoming release tags, regular meeting notific
1818

1919
[How to Contribute](https://github.com/NGEET/fates/blob/master/CONTRIBUTING.md)
2020

21-
[Table of FATES and Host Land Model API compatability](https://fates-users-guide.readthedocs.io/en/latest/user/Table-of-FATES-API-and-HLM-STATUS.html)
21+
[Table of FATES and Host Land Model API compatability](https://fates-users-guide.readthedocs.io/en/latest/user/release-tags-compat-table.html)
2222

2323
[List of Unsupported or Broken Features](https://fates-users-guide.readthedocs.io/en/latest/user/Current-Unsupported-or-Broken-Features.html)
2424

@@ -35,4 +35,4 @@ https://github.com/E3SM-Project/E3SM
3535

3636
https://github.com/ESCOMP/cesm
3737

38-
The FATES, E3SM and CTSM teams maintain compatability of the NGEET/FATES master branch with the E3SM master and CTSM master branches respectively. There may be some modest lag time in which the latest commit on the FATES master branch is available to these host land models (HLM) by default. This is typically correlated with FATES development updates forcing necessary changes to the FATES API. See the table of [FATES API/HLM compatibility](https://fates-users-guide.readthedocs.io/en/latest/user/Table-of-FATES-API-and-HLM-STATUS.html) for information on which fates tag corresponds to which HLM tag or commit.
38+
The FATES, E3SM and CTSM teams maintain compatability of the NGEET/FATES master branch with the E3SM master and CTSM master branches respectively. There may be some modest lag time in which the latest commit on the FATES master branch is available to these host land models (HLM) by default. This is typically correlated with FATES development updates forcing necessary changes to the FATES API. See the table of [FATES API/HLM compatibility](https://fates-users-guide.readthedocs.io/en/latest/user/release-tags-compat-table.html) for information on which fates tag corresponds to which HLM tag or commit.

0 commit comments

Comments
 (0)