Instructions for including your repository in the nmfs-ost organization

Collaborators

If you have NMFS collaborators on your repository who are not members of the NMFS GitHub Enterprise Cloud (GHEC) account, have them complete the OST GHEC Interest Form). If they are not NOAA NMFS FTEs or Affiliates, contact an administrator to help you add them to your repository or to transfer in your repository with outside collaborators.

For repositories migrated to nmfs-ost organization

1. Update your README.md file to include the disclaimer and a license. See below for a description of licenses.
2. Include an “about” statement in each repository to make it clear what the purpose of the repository is.
3. Add topics to help users find repositories.
4. Add a license. This is a MUST for public repositories. If you are migrating a private repository, it is strongly advised to add a license but not required. Work written by For work produced by U.S. government employees, we are required to use an open source license. If contributors other than FTEs wrote code and the repository does not yet have an open source license, make sure all parties agree before applying an open source license. For data/documentation, use CC0. For code, common choices include Apache 2.0 and MIT.
5. For private or internal repositories, add the file .github/workflows/secretSCAN.yml. This is a GitHub action that will check for token and keys that are accidentally committed to a repository.
6. For public repositories, the secretSCAN.yml file is not needed. Instead, check that GitHub secret scanning is enabled for the repository.

For new repositories in nmfs-ost organization

Create a repository from this template and follow the instructions below.

1. Include an “about” statement in each repository to make it clear what the purpose of the repository is.
2. Add topics to help users find repositories.
3. Add a license. This is a MUST for public repositories. If you are migrating a private repository, it is strongly advised to add a license but not required. Work written by For work produced by U.S. government employees, we are required to use an open source license. If contributors other than FTEs wrote code and the repository does not yet have an open source license, make sure all parties agree before applying an open source license. For data/documentation, use CC0. For code, common choices include Apache 2.0 and MIT.
4. For private or internal repositories, Confirm that the file .github/workflows/secretSCAN.yml is in this repository. This is a GitHub action that will check for token and keys that are accidentally committed to a repository.
5. For public repositories, you may delete the file .github/workflows/secretSCAN.yml. This is because GitHub secret scanning is used in Public Repositories.
6. Once you have completed the steps, delete the instructions from this README.md.

Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.