Skip to content

Commit ac3e9fc

Browse files
authored
Update README info
1 parent 3ff1f89 commit ac3e9fc

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

GitHub-Guide.qmd

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -312,16 +312,18 @@ Example of back-up scripts to Google Drive:
312312

313313
## GitHub Repository Components
314314

315+
Your repository should include a README (@sec-readme), the government product DISCLAIMER (@sec-disclaimer), and LICENSE file (@sec-license). If the work is something that can be cited, then also include citation information and a DOI.
316+
315317
### README.md {#sec-readme}
316318

317-
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:
319+
This file should provide a description of the repository. The contents of the README file will vary greatly depending on the application, but there are a few common elements for NOAA Fisheries work products: title, description, developer information, disclaimer (@sec-disclaimer), NOAA Fisheries logo, and DOC footer. See examples from repositories linked on the [Fisheries Integrated Toolbox](https://noaa-fisheries-integrated-toolbox.github.io/).
320+
321+
Specialized repositories will have additional elements in their README:
318322

319-
* **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.
320-
* **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)
323+
* **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) and tools linked in the Fisheries Integrated Toolbox.
321324
* **A report or paper.** Authors, description and citation.
322-
* Add the DISCLAIMER (below) for any repository that is a 'work product'.
323325

324-
### DISCLAIMER.md {#sec-disclaimer}
326+
### DISCLAIMER.md {}
325327

326328
Repositories and web content shared on GitHub should make it clear to the audience that no information should be considered or interpreted as official communication of NOAA. The simplest method for doing this is to include the disclaimer text as a footnote within the repository's `README.md` and any web content available from that repository. Be careful not to use NOAA logos and and NOAA Fisheries branding in a way that could imply official communication. NOAA logos should be used to indicate your affiliation and acknowledge support and funding. The repositories within the [NOAA Fisheries Integrated Toolbox](https://github.com/nmfs-fish-tools) GitHub organization are examples of how to prepare README files with the Disclaimer and NOAA Fisheries logos.
327329

0 commit comments

Comments
 (0)