diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000000000000000000000000000000000..aaf77a3775e86614190d55088b21a86a76faa373 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,6 @@ +# Code of Conduct + +All contributions to and interactions surrounding this project will abide by +the [USGS Code of Scientific Conduct][1]. + +[1]: https://www.usgs.gov/about/organization/science-support/office-science-quality-and-integrity/code-scientific-conduct diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..392f301996227adf4d47c65cb00083c14e53776d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing + +Contributions are welcome from the community. Questions can be asked on the +[issues page][1]. Before creating a new issue, please take a moment to search +and make sure a similar issue does not already exist. If one does exist, you +can comment (most simply even with just a `:+1:`) to show your support for that +issue. + +If you have direct contributions you would like considered for incorporation +into the project you can [fork this repository][2] and +[submit a merge request][3] for review. + +## Style Guide + +This project loosely adheres to [Google Java Style][4] and is informed by +[Effective Java][5]. All source files and documentation are encoded using +[UTF-8][6]]. Developers should also consider the following: + +* Line lengths: + * code: __100__, but shorter is better. + * comments: __80__, for readability. +* Use unicode symbols where possible: `double μ = 0.4;` +* Use static imports for only the most common utilities and preconditions: + * `java.lang.math` + * `com.google.common.base.Preconditions` + +[1]: https://code.usgs.gov/ghsc/nshmp/nshmp-netcdf/-/issues +[2]: https://docs.gitlab.com/ee/gitlab-basics/fork-project.html +[3]: https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html +[4]: https://google.github.io/styleguide/javaguide.html +[5]: http://en.wikipedia.org/wiki/Joshua_Bloch#Effective_Java +[6]: https://en.wikipedia.org/?title=UTF-8 diff --git a/LICENSE.md b/LICENSE.md index 489918d8177cd3d363aaf8e2d62e2b87559fb08e..b2c7f0d8098170d22c81eca2386e138c78e08e90 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,18 +1,17 @@ # License -Unless otherwise noted, This project is in the public domain in the United +Unless otherwise noted, this project is in the public domain in the United States because it contains materials that originally came from the United States Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at -<https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits> +<https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits>. Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication. ## CC0 1.0 Universal Summary -This is a human-readable summary of the -[Legal Code (read the full text)][1]. +This is a human-readable summary of the [Legal Code (read the full text)][1]. ### No Copyright diff --git a/README.md b/README.md index 975223fd2604a0f28c98404634716ca74f6e884a..7e07378edf20cd10b1886b087d6c47c08f22c70b 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ -# nshmp-lib +# nshmp-ws-static + +Static hazard web service. diff --git a/code.json b/code.json new file mode 100644 index 0000000000000000000000000000000000000000..b3c959ef99d31533e3ae719fb42a84f5cbf35cab --- /dev/null +++ b/code.json @@ -0,0 +1,47 @@ +[ + { + "name": "nshmp-ws-static", + "organization": "U.S. Geological Survey", + "description": "Static hazard curve web serivce for the NSHMP", + "version": "#.#.#", + "status": "Production", + "doi": "doi:###TBD###", + + "permissions": { + "usageType": "openSource", + "licenses": [ + { + "name": "Public Domain, CC0-1.0", + "URL": "https://code.usgs.gov/ghsc/nshmp/nshmp-ws-static/-/blob/main/LICENSE.md" + } + ] + }, + + "repositoryURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-ws-static", + "homepageURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-ws-static", + "downloadURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-ws-static/-/releases/tag/v#.#.#", + "disclaimerURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-ws-static/-/blob/main/DISCLAIMER.md", + "vcs": "git", + + "laborHours": 100, + + "languages": [ "Java" ], + + "tags": [ + "Earthquake Hazards", + "Geologic Hazards Science Center", + "static-hazard", + "web-service", + "doi|###TBD###" + ], + + "contact": { + "name": "Peter Powers", + "email": "pmpowers@usgs.gov" + }, + + "date": { + "metadataLastUpdated": "2021-08-03" + } + } +]