Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eeholmes authored Feb 15, 2024
1 parent f5daecc commit b5a8e3e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

## Collaborators

If you have collaborators on your repository who are not members of the NMFS GitHub Enterprise Cloud account, have them complete a [user request](https://sites.google.com/noaa.gov/nmfs-st-github-governance-team/github-users), if they cannot be a member of the NMFS account, contact an administrator to help you add them to your repository or to transfer in your repository with outside collaborators.
If you have NMFS collaborators (i.e. have noaa.gov email) on your repository who are not members of the NMFS GitHub Enterprise Cloud account, have them complete a [user request](https://sites.google.com/noaa.gov/nmfs-st-github-governance-team/github-users). If they are not NOAA FTEs or Affiliates, contact an administrator to help you add them to your repository or to transfer in your repository with outside collaborators. You will find the list of admins in the [noaa-nwfsc Google folder](https://drive.google.com/drive/folders/1k54HDpe6AcpfZ9LZzdIARFbH6wdi8pGl?usp=sharing).

## For repositories migrated to noaa-nwfsc organization

1) Update your `README.md` file to include the disclaimer and an open access license (if repo is public). These are below.
1) Update your `README.md` file to include the disclaimer and an open access license. See below for a description of licenses.
2) Add a description and info on who created the content (otherwise the org managers will not know who to contact).
3) Add tags (far right side on repo) to help users find repositories. See the other repositories for examples.
4) Add the LICENSE file and edit for your content. Note LICENSE files are important for repositories that are public and that are "products" in some way. For example, data, code package, documentation, etc.
4) Add an open LICENSE file. For government work, we are required to use an open LICENSE. If non-government FTEs were contributors and the repository does not yet have an open license on it, make sure all parties agree before applying an open source license.
5) Add the file `.github/workflows/secretSCAN.yml`. This will check for token and keys that are accidentally committed to a repository.

## For new repositories in noaa-nwfsc organization

1) Add a description and info on who created the content to this `README.md` file (otherwise the org managers will not know who to contact).
2) Add tags (far right side on repo) to help users find repositories. See the other repositories for examples.
3) Confirm that the License (see License tab) is appropriate for the content in your repository. Note LICENSE files are important for repositories that are public and that are "products" in some way. For example, data, code package, documentation, etc.
3) Confirm that the License (see License tab) is appropriate for the content in your repository. Adding an open LICENSE file at the start of work clarifies that this work is open source (public domain) to any future contributors to the work.
4) Confirm that the file `.github/workflows/secretSCAN.yml` is in this repository. This will check for token and keys that are accidentally committed to a repository.
5) Once you have completed the first four steps, delete the instructions from this `README.md`.

Expand Down

0 comments on commit b5a8e3e

Please sign in to comment.