Add CONTRIBUTING documentation#460
Conversation
danrosen25
requested review from
anntsay,
billsacks,
oehmke,
theurich and
uturuncoglu
|
Note that the current coding conventions (a.k.a. syntax guidelines) , although documented in the Developer's Guide, are inconsistent. The best way to follow coding conventions is to follow precedence in key ESMF files. At this time we will not document this process but we plan to cleanup syntax and add guidelines in the future. Doing so will also allow us to add a linter. |
|
@esmf-org/esmf-developers please review this so we could close this ticket for 9.0.0 |
|
Contributing instructions and guidelines will be modified once devcontainers are in place. |
theurich
left a comment
theurich
left a comment
There was a problem hiding this comment.
I think this looks really good! The only one suggestion I have is to make it pretty clear that our Developer's guide is outdated and should be used with caution.
| * 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) |
There was a problem hiding this comment.
| * Developer’s Guide - [html](https://earthsystemmodeling.org/docs/nightly/develop/dev_guide) | |
| * Developer’s Guide - [html](https://earthsystemmodeling.org/docs/nightly/develop/dev_guide) (Outdated! Use with caution. Ask if unsure.) |
3 participants
Add CONTRIBUTING.md file to document the ESMF contribution/pull request process.
View file here: https://github.com/danrosen25/esmf/blob/contributing/CONTRIBUTING.md