From 5ce12321a2fb33a428c3e7fb2dddac03276083da Mon Sep 17 00:00:00 2001
From: Konrad Pabjan <konradpabjan@github.com>
Date: Thu, 20 Feb 2020 13:59:00 -0500
Subject: [PATCH] Documentation for the basic workflow

---
 ci/blank.yml          | 14 +++++++++++++-
 ci/node.js.yml        |  3 +++
 ci/python-app.yml     |  3 +++
 ci/python-package.yml |  4 ++++
 ci/python-publish.yml |  3 +++
 5 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/ci/blank.yml b/ci/blank.yml
index 5b5d105..81e3002 100644
--- a/ci/blank.yml
+++ b/ci/blank.yml
@@ -1,20 +1,32 @@
+# This is a basic workflow to help you get started with Actions
+
 name: CI
 
+# Controls when the action will run. Triggers the workflow on push or pull request 
+# events but only for the master branch
 on:
   push:
     branches: [ master ]
   pull_request:
     branches: [ master ]
 
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
+  # This workflow contains a single job called "build"
   build:
-
+    # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
+    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - uses: actions/checkout@v2
+
+    # Runs a single command using the runners shell
     - name: Run a one-line script
       run: echo Hello, world!
+
+    # Runs a set of commands using the runners shell
     - name: Run a multi-line script
       run: |
         echo Add other actions to build,
diff --git a/ci/node.js.yml b/ci/node.js.yml
index d924921..e7081a4 100644
--- a/ci/node.js.yml
+++ b/ci/node.js.yml
@@ -1,3 +1,6 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
 name: Node.js CI
 
 on:
diff --git a/ci/python-app.yml b/ci/python-app.yml
index 5536372..1519cec 100644
--- a/ci/python-app.yml
+++ b/ci/python-app.yml
@@ -1,3 +1,6 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
 name: Python application
 
 on:
diff --git a/ci/python-package.yml b/ci/python-package.yml
index a51d5a0..846b2f9 100644
--- a/ci/python-package.yml
+++ b/ci/python-package.yml
@@ -1,3 +1,6 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
 name: Python package
 
 on:
@@ -5,6 +8,7 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+
 jobs:
   build:
 
diff --git a/ci/python-publish.yml b/ci/python-publish.yml
index b143a53..b20652e 100644
--- a/ci/python-publish.yml
+++ b/ci/python-publish.yml
@@ -1,3 +1,6 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
 name: Upload Python Package
 
 on: