From 8cf6160c06ee8db0c8295d8c0498fd791d7db56a Mon Sep 17 00:00:00 2001 From: Jordan McClintock Date: Wed, 23 Feb 2022 15:39:24 -0600 Subject: [PATCH] docs update --- docs/code-contribution.md | 2 +- docs/sparkles-guides-contribution.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/code-contribution.md b/docs/code-contribution.md index 039f12267..689e86f67 100644 --- a/docs/code-contribution.md +++ b/docs/code-contribution.md @@ -2,7 +2,7 @@ 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. +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 `2022 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. diff --git a/docs/sparkles-guides-contribution.md b/docs/sparkles-guides-contribution.md index a8a656cc8..5d43a930c 100644 --- a/docs/sparkles-guides-contribution.md +++ b/docs/sparkles-guides-contribution.md @@ -11,7 +11,7 @@ At the simplest level: ## Conventions and Guidelines -- Topics within flows, build upon each other from left to right. For example, knowing containerization prior to kubernetes. +- Topics within flows, build upon each other from top to bottom. For example, knowing containerization prior to kubernetes. - Use subflows when a common topic exists. Ex. Zarf requires golang, which is a learning topic itself, or BigBang requires kubernetes - Add materials (youtube, course, SME, article, etc...) to the description of nodes. - Add a * to materials that you found helpful