Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.57 KB

ices_github_guidelines.md

File metadata and controls

48 lines (33 loc) · 1.57 KB
Raw

ICES GitHub Guidelines

ICES provides four GitHub areas to facilitate scientific collaboration in marine research:

  1. Expert Groups
    https://github.com/ices-eg

  2. Tools under development
    https://github.com/ices-tools-dev

  3. Tools maintained by ICES
    https://github.com/ices-tools-prod

  4. Transparent Assessment Framework
    https://github.com/ices-taf

The code in these repositories can be browsed and downloaded. To apply for write access to specific repositories, please send an email to [email protected].

The distinction between tools-prod and tools-dev is that github.com/ices-tools-prod contains software that is operational and maintained by the ICES Secretariat, while github.com/ices-tools-dev contains everything else (operational software maintained by scientists outside the Secretariat, experimental projects, etc.)

The main guidelines for working in the ICES GitHub areas are:

  • Users should provide their full name in their GitHub profile (https://github.com/settings/profile).

  • Repositories should be kept under 1 GB and should mainly contain code and configuration files. Large datasets, images, and documents are better stored elsewhere.

  • Expert Group chairs may recommend a certain GitHub workflow for that group.

The main GitHub help page can be found at:
https://help.github.com

A hello world tutorial can be found at:
https://guides.github.com/activities/hello-world/

Other help resources, including the Git book, are listed in the R development guidelines used by the ICES Secretariat:
https://github.com/ices-tools-prod/doc