Skip to content

Commit

Permalink
Add guidelines for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ccarouge committed Sep 26, 2023
1 parent 74395f9 commit dd95aac
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions documentation/docs/developer_guide/contribution_flowchart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

These guidelines are written from the perspective of a new contributor to CABLE wanting to start their first development. Notes are added when guidelines for subsequent contributions differ.

:material-sim-alert: The CABLE documentation is an integral part of the CABLE code and its repository. The present guidelines apply for changes to the scientific code as well as to the documentation. All changes to the scientific code **must** be accompanied by adequate changes to the documentation. The changes to the documentation are expected to be part of the same set of changes as the scientific modifications. The documentation changes **must** not be submitted separately, except for corrections. You can refer to [the documentation guidelines][doc-guidelines] to know what level of documentation is expected and how to document code changes.

!!! info "Resources"

Please refer to [this cheat sheet page][cheatsheet] for quick references to Git, Markdown and FORD syntax.
Expand Down

0 comments on commit dd95aac

Please sign in to comment.