-
Notifications
You must be signed in to change notification settings - Fork 89
Add CONTRIBUTING documentation #460
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
danrosen25
wants to merge
2
commits into
esmf-org:develop
Choose a base branch
from
danrosen25:contributing
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+64
−0
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,64 @@ | ||
| The [Earth System Modeling Framework](https://earthsystemmodeling.org/) (ESMF) | ||
| is high-performance, flexible software infrastructure for building and coupling | ||
| weather, climate, and related Earth science applications. Please review the | ||
| following guidelines for contributing to the Earth System Modeling Framework. | ||
|
|
||
| [fork]: https://github.com/esmf-org/esmf/fork | ||
| [pr]: https://github.com/esmf-org/esmf/compare | ||
| [actions]: https://github.com/esmf-org/esmf/actions | ||
|
|
||
| ## Resources | ||
|
|
||
| * ESMF User Guide - [html](https://earthsystemmodeling.org/docs/nightly/develop/ESMF_usrdoc), [pdf](https://earthsystemmodeling.org/docs/nightly/develop/ESMF_usrdoc.pdf) | ||
| * Fortran Reference Manual - [html](https://earthsystemmodeling.org/docs/nightly/develop/ESMF_refdoc), [pdf](https://earthsystemmodeling.org/docs/nightly/develop/ESMF_refdoc.pdf) | ||
| * C Reference Manual - [html](https://earthsystemmodeling.org/docs/nightly/develop/ESMC_crefdoc), [pdf](https://earthsystemmodeling.org/docs/nightly/develop/ESMC_crefdoc.pdf) | ||
| * NUOPC Reference Manual - [html](https://earthsystemmodeling.org/docs/nightly/develop/NUOPC_refdoc), [pdf](https://earthsystemmodeling.org/docs/nightly/develop/NUOPC_refdoc.pdf) | ||
| * ESMPy Documentation - [html](https://earthsystemmodeling.org/esmpy_doc/nightly/develop/html), [pdf](https://earthsystemmodeling.org/esmpy_doc/nightly/develop/ESMPy.pdf) | ||
| * Developer’s Guide - [html](https://earthsystemmodeling.org/docs/nightly/develop/dev_guide) | ||
|
|
||
| ## Submitting a pull request | ||
|
|
||
| 1. [Fork][fork] and clone the repository | ||
| 2. Create a new branch: `git checkout -b my-branch-name` | ||
| 3. Make and [test](#testing) your changes | ||
| 4. Update [documentation](#documentation) | ||
| 5. Push to your fork | ||
| 6. Execute `ESMF CI` and `ESMF Docs` from your fork on your branch using [actions][actions] | ||
| 7. Compare across forks and [submit a pull request][pr] | ||
|
|
||
| ## Testing | ||
|
|
||
| Pull requests must pass the [ESMF CI][actions] action before they are accepted | ||
| into the `develop` branch. The [ESMF CI][actions] action is configured to test | ||
| ESMF on a variety of configurations. These include multiple operating systems, | ||
| MPI libraries, compilers, and build options. Prior to executing the | ||
| [ESMF CI][actions] action, changes should pass `make all_tests` on a local | ||
| machine or HPC. | ||
|
|
||
| ## Documentation | ||
|
|
||
| ESMF uses LaTeX and LaTeX extensions to build inline documentation. | ||
| Documentation can be built using the [ESMF Docs][actions] action, which provides | ||
| all the software needed to build documentation. Documentation can also be built | ||
| locally using `texlive-full` and `latex2html`. ESMPY also requires the following | ||
| Python packages: `sphinx`, `sphinxcontrib-packages` and `sphinxcontrib-bibtex`. | ||
|
|
||
| * ESMF Documentation `cd ${ESMF_DIR} && make doc` | ||
| * ESMF Developers Guide: `cd ${ESMF_DIR}/src/doc/dev_guide && make` | ||
| * NUOPC Documentation `cd ${ESMF_DIR}/src/addon/NUOPC/doc && make localdoc` | ||
| * ESMPY Documentation `cd ${ESMF_DIR}/src/addon/esmpy && . ${PYTHON_VENV_ACTIVATE} && python3 -m pip install . && cd doc && . ${PYTHON_VENV_ACTIVATE} && make html latexpdf` | ||
|
|
||
| ## Contact Us | ||
|
|
||
| [ESMF Discussions](https://github.com/orgs/esmf-org/discussions) is a GitHub | ||
| Discussions forum for publicly discussing ESMF concerns and requests. For more | ||
| information please see the | ||
| [ESMF Discussions How-To Guide](https://github.com/orgs/esmf-org/discussions/246). | ||
|
|
||
| If you do not have a GitHub Account, if you have privacy concerns posting to | ||
| ESMF Discussions, or if you prefer communication via email then please contact | ||
| esmf_support@ucar.edu. | ||
|
|
||
| --- | ||
| Thank You,<br> | ||
| The ESMF Core Team | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.