ACCORD_Code_documentation

Repository for markdown ACCORD Code documentation

1. Get into the code

Go to ACCORD GitHub and get familiarized with all the common repositories etc

GitHub ACCORD is at: https://github.com/ACCORD-NWP

General instructions about how to start are in the WIKI

https://opensource.umr-cnrm.fr/projects/accord/wiki/Forge_and_contribution_instructions

and more in detail:

https://github.com/ACCORD-NWP/IAL/blob/master/.github/CONTRIBUTING.md

https://github.com/orgs/ACCORD-NWP/discussions/72

https://github.com/orgs/ACCORD-NWP/discussions/60

and there is a nice Webminar recorded at https://www.umr-cnrm.fr/accord/IMG/mp4/webinars_accord_forge_davai_with_cy49t1_2_.mp4

At https://github.com/ACCORD-NWP/ACCORD-NWP.github.io you will find detailed information about some of the importante repositories.

2. Configure your settings for a smooth Git connection

Go to your account Settings > Developer settings > Personal access tokens

Generate new token (setting “repo” as scope, and with a reasonable expiry date)

Set this token in any host .netrc file: machine github.com login password in case you organisation is using a proxy, you need to tell Git to use it: e.g. export GIT_SSL_CAINFO=/usr/local/etc/proxy1.pem in MF/CNRM

3. How to Document the Code in github ACCORD

Here in ACCORD Github there are several repositories where apart of finding the code related to the topic of the repository, there is always a README.md file.

That README.md should have the detailed description of WHAT it is in the repository and HOW to use it. Please give the best description that is possible to make easy to anyone to use the code there. And please write your email at the end, so anyone that have questions could email you.

Here there are some tips of good practices of documentation: [https://github.com/openai/openai-cookbook/blob/main/articles/what_makes_documentation_good.md]