USGS-R / protoloads

Prototyping and exploring options for broad-scale load forecasting
0 stars 4 forks source link

Prepare for Upcoming DGEC Transition #83

Open jesse-ross opened 1 year ago

jesse-ross commented 1 year ago

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 a LICENSE.txt, this PR will try to create a LICENSE.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 here

The 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:

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.