diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000000000000000000000000000000000..f350cdf4aa19983302c066f881044a8f5acd0086 --- /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). + + + +## [Unreleased] + +### Added + +### Fixed + +### Changed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..5045eea8446c0e4abcd7c3bbab3d5c46de8deae0 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 “”` where is your commit message. Then, push up your changes to your fork +`git push origin ` where `` 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 `` 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 0000000000000000000000000000000000000000..dee4c3db580376ab26139afe34428b41f1b1c9aa --- /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