From 2780da5a420fb3b87db45828ab9ca3e3dec20e33 Mon Sep 17 00:00:00 2001
From: Christine Kim <125395064+chkim-usgs@users.noreply.github.com>
Date: Wed, 13 Sep 2023 14:21:33 -0700
Subject: [PATCH] Update docs (#1)

* Update docs

* Fix my typo

* Added extension to license file and metadata file

* Updated laborHours
---
 CHANGELOG.md          | 42 +++++++++++++++++++++++++++++++++++++
 CONTRIBUTING.md       | 16 +++++++++++++++
 LICENSE => LICENSE.md |  0
 code.json             | 48 +++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 106 insertions(+)
 create mode 100644 CHANGELOG.md
 rename LICENSE => LICENSE.md (100%)
 create mode 100644 code.json

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..f350cdf
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,42 @@
+# Changelog
+
+All changes that impact users of this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!---
+This document is intended for users of the applications and API. Changes to things
+like tests should not be noted in this document.
+
+When updating this file for a PR, add an entry for your change under Unreleased
+and one of the following headings:
+ - Added - for new features.
+ - Changed - for changes in existing functionality.
+ - Deprecated - for soon-to-be removed features.
+ - Removed - for now removed features.
+ - Fixed - for any bug fixes.
+ - Security - in case of vulnerabilities.
+
+If the heading does not yet exist under Unreleased, then add it as a 3rd heading,
+with three #.
+
+
+When preparing for a public release candidate add a new 2nd heading, with two #, under
+Unreleased with the version number and the release date, in year-month-day
+format. Then, add a link for the new version at the bottom of this document and
+update the Unreleased link so that it compares against the latest release tag.
+
+
+When preparing for a bug fix release create a new 2nd heading above the Fixed
+heading to indicate that only the bug fixes and security fixes are in the bug fix
+release.
+-->
+
+## [Unreleased]
+
+### Added
+
+### Fixed
+
+### Changed
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e69de29..5045eea 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+# Build SpiceQL
+To get started, check out the [steps](https://github.com/DOI-USGS/SpiceQL/blob/main/README.md#building-the-library) to create a local build of SpiceQL.
+
+# Pick an Issue
+Next, you are ready to pick an issue to start working on. Head over to the [issues page](https://github.com/DOI-USGS/SpiceQL/issues), where you will find bugs, questions, and feature requests. This will show you all of the open issues that will be a good place to start developing. Pick an issue that you may want to work on, click on the issue title to go to its page,  and assign yourself to that issue by clicking on “assign yourself” under the “Assignees” section to the right of the issue description. Now, you are ready to start developing.
+
+# Document Your Changes
+Once you have completed the ticket, i.e., by fixing an issue or adding a feature, make sure you have updated any documentation and the CHANGELOG.md when applicable.
+
+# Test Your Changes
+You will also need to test the code, update any tests that are now failing because of the changes, or add new tests that cover your changes. Check out the [Building The Library](https://github.com/DOI-USGS/SpiceQL/blob/main/README.md#building-the-library) part of the README to see how to run SpiceQL tests.
+
+# Create a Pull Request
+Next, commit your changes to your local branch with the command 
+`git commit -m “<message>”` where <message> is your commit message. Then, push up your changes to your fork 
+`git push origin <branch_name>` where `<branch_name>` is the name of your local branch you made your changes on. Finally, head over to your fork, click on the “Branch” dropdown, select the branch `<branch_name>` from the dropdown, and click “New Pull Request”. Give your PR a descriptive but brief title and fill out the description skeleton. After submitting your PR, wait for someone to review it, and make any necessary changes.
diff --git a/LICENSE b/LICENSE.md
similarity index 100%
rename from LICENSE
rename to LICENSE.md
diff --git a/code.json b/code.json
new file mode 100644
index 0000000..dee4c3d
--- /dev/null
+++ b/code.json
@@ -0,0 +1,48 @@
+[
+    {
+      "name": "SpiceQL",
+      "organization": "U.S. Geological Survey",
+      "description": "GitLab repository for library that interacts with NAIF's SPICE kernels",
+      "version": "main",
+      "status": "Development",
+  
+      "permissions": {
+        "usageType": "openSource",
+        "licenses": [
+          {
+            "name": "Public Domain, CC0-1.0",
+            "URL": "https://code.usgs.gov/astrogeology/spiceql/-/raw/main/LICENSE.md"
+          }
+        ]
+      },
+  
+      "homepageURL": "https://code.usgs.gov/astrogeology/spiceql/",
+      "downloadURL": "https://code.usgs.gov/astrogeology/spiceql/-/archive/main/spiceql-main.zip",
+      "disclaimerURL": "https://code.usgs.gov/astrogeology/spiceql/-/raw/main/DISCLAIMER.md",
+      "repositoryURL": "https://code.usgs.gov/astrogeology/spiceql.git",
+      "vcs": "git",
+  
+      "laborHours": 520,
+  
+      "tags": [
+        "Planetary",
+        "Remote Sensing",
+        "Data Processing",
+        "Ephemerides",
+        "Kernels"
+      ],
+  
+      "languages": [
+        "C++"
+      ],
+  
+      "contact": {
+        "name": "Kelvin Rodriguez",
+        "email": "krodriguez@usgs.gov"
+      },
+  
+      "date": {
+        "metadataLastUpdated": "2023-09-13"
+      }
+    }
+  ]
\ No newline at end of file
-- 
GitLab