From 086a689bf978442c8aa57ad187b903fb72ef4ba0 Mon Sep 17 00:00:00 2001 From: "andrew.greene" Date: Fri, 10 Dec 2021 14:41:51 -0700 Subject: [PATCH] Add Sparkles Guide code contribution guidelines --- README.md | 3 +-- docs/code-contribution.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) create mode 100644 docs/code-contribution.md diff --git a/README.md b/README.md index 9a591bb39..0d69f617d 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,7 @@ See [this](docs/sparkles-guides-contribution.md) guide, if you are looking to co ### To Code ->coming soon... -1. `npm run dev` # auto load code changes +See [this](docs/code-contribution.md) guide, if you are looking to add/remove/modify code implementing Sparkle's Guide. ## Copyright and license diff --git a/docs/code-contribution.md b/docs/code-contribution.md new file mode 100644 index 000000000..e8fdba8f9 --- /dev/null +++ b/docs/code-contribution.md @@ -0,0 +1,19 @@ +# Code Contribution + +Sparkles guide is forked from Node-red, which has a LOT of functionality in addition to the nice UI we use. As such, much code is not relevant for our purpose. + +Since this is a derivative work, using an Apache 2.0 license. We MUST add a modification copyright to any changed files not originated by us. Add `2021 Modification Copyright - Defense Unicorns` as a comment to the top of any changed file. + +Finally, deleting code often has unintended consequences - you should, at a minimum, add cypress tests to confirm basic, common functionality to ensure functionality. + +## Running the code + +1. `npm install` +2. `npm run dev` # auto load code changes +3. open + +## Testing code + +1. `npm run dev` or `npm start` +2. `npm run cy:run` # Runs cypress tests +