This repository has been archived by the owner on Jun 1, 2023. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Starting on September 30, 2023, USGS GitHub repositories will no longer be permitted to remain in existing organizations such as USGS-R on the public GitHub. Instead, they must be either (a) migrated to the DOI GitHub Enterprise Cloud (DGEC), (b) migrated to the USGS GitLab instance, or (c) archived.
In order to be made public, all USGS software, whether provisional or approved, must contain all necessary legal and metadata assets. The purpose of this PR is to ease the transition by creating the necessary files, so that people can do the necessary migration work with less research time.
The files added here are generated based on some assumptions, and without looking at the contents of any existing files. For instance, if this repo already has a
LICENSE.md
, the process which is generating this PR will not add one to the PR, but it does not make any attempt to validate the existing file. Similarly, the code is not at all clever about finding similarly-named files. For instance, if you already have aLICENSE.txt
, this PR will try to create aLICENSE.md
anyways!The
DISCLAIMER.md
provided here is for a provisional release. If an official release is intended, a different disclaimer template may be found hereThe
LICENSE.md
provided here is the most common choice, but as the owner of the repository you need to look it over and make sure that it is a good match for your repository. The Office of the Solicitor is the only entity that can provide legal advice on this matter.Note especially that the
code.json
created by this PR will need to be manually edited in order to be correct. In this file, the following are likely to require modification:main
. If there are tagged versions, they will need to be added by hand.code.json
file will contain two sections, which are intended for different branches or version releases. You may want to remove one of these, or you may want to add more.For examples of valid
code.json
files, please see https://github.com/DOI-USGS/dataRetrieval/blob/main/code.json or https://github.com/DOI-USGS/snow-to-flow/blob/main/code.jsonIn addition to the necessary legal and metadata assets, all public software requires a security review. See this guidance for more information. Additionally, a useful FAQ with links to details of USGS policy and the specifics of this migration is located here.