Skip to content

Commit 1f22a47

Browse files
authored
Update GitHub-Guide.qmd
1 parent 012ec38 commit 1f22a47

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

GitHub-Guide.qmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: GitHub and Git
33
subtitle: |
44
Guidance and Best Practices for NMFS Users \
5-
version 3.7
6-
date: "November 29, 2024"
5+
version 3.8
6+
date: "January 14, 2025"
77
author:
88
- name: NMFS Open Science GitHub working group
99
format:
@@ -17,7 +17,7 @@ format:
1717
\usepackage[headsepline,automark]{scrlayer-scrpage}
1818
\ohead{\pagemark}
1919
\chead{}
20-
\ihead{GitHub and Git SOP from NMFS Open Science (Nov 2024)}
20+
\ihead{GitHub and Git SOP from NMFS Open Science (Jan 2025)}
2121
documentclass: scrartcl
2222
number-sections: true
2323
titlepage: "plain"
@@ -301,9 +301,9 @@ Example of back-up scripts to Google Drive:
301301

302302
This file should provide a description of the repository. The contents of the README file will vary greatly depending on the application. Here are some tips:
303303

304-
* **An official work product released on a NOAA-branded GitHub organization**. This is the most formal instance and the organization leaders should develop template READMEs to provide a consistent format across the products.
305-
* **A software package (e.g., R package)**. Standard components are: Badges indicating build status and version, how to install, how to use or link to documentation, where to report issues, citation.
306-
* **A report or paper.** Author, description and citation.
304+
* **An official work product released on a NOAA-branded GitHub organization**. This is the most formal case and the organization leaders should develop template READMEs to provide a consistent format across the products.
305+
* **A software or code package (e.g., R package)**. Standard components are: Badges indicating build status and version, description, how to install, how to use or link to documentation, where to report issues, authors, citation. [Example](https://github.com/nwfsc-cb/rCAX/blob/main/README.md)
306+
* **A report or paper.** Authors, description and citation.
307307
* Add the DISCLAIMER (below) for any repository that is a 'work product'.
308308

309309
### DISCLAIMER.md {#sec-disclaimer}

0 commit comments

Comments
 (0)