Skip to content

Commit

Permalink
'
Browse files Browse the repository at this point in the history
  • Loading branch information
chloemackallah authored Sep 25, 2023
1 parent 94dbeea commit cd4217d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Governance/create/create-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ While similar to DMP in many ways, **data documentation** is a distinct purpose

## Code management & version control

Best practice for managing software of any kind starts with *version controlled repositories*. Git-based platforms (e.g., GitHub and GitLab instances such as the [NCI GitLab](https://git.nci.org.au/)) and APIs are the current standard, although SVN and other tools are also in use throughout climate science. Learning these tools are vital to software development, and the versioning native in these systems help ensure provenance, reproduction, and creating FAIR datasets for sharing and publication.
Best practice for managing software of any kind starts with **version controlled repositories**. Git-based platforms (e.g., GitHub and GitLab instances such as the [NCI GitLab](https://git.nci.org.au/)) and APIs are the current standard, although SVN and other tools are also in use throughout climate science. Learning these tools are vital to software development, and the versioning native in these systems help ensure provenance, reproduction, and creating FAIR datasets for sharing and publication.
Releases (Git-based publications) of specific versions can be useful to complement published datasets or papers, however it is important to note that independent publication of code (e.g. via Zenodo) is required for a DOI and is recommended to ensure long-term access and reproducibility.

Of course, code cannot exclusively exist in a repository. It is suggested (particularly if your data is an analysis product) to keep the code nearby the data (e.g. in the same parent directory) or document where it can be accessed in a readily available README file (also note the version of the code used to create the associated dataset!).
Expand Down

0 comments on commit cd4217d

Please sign in to comment.