Merge pull request #27 from STEM-C/feature/git-flow

Update git flow

README.md

@@ -1,5 +1,7 @@
 # STEM+C
 
+> Cloud-based programming interface
+
 <br/>
 
 ## Scaffolds
@@ -21,7 +23,8 @@
 
 ## Environments
 
-The project is divided into three conceptual environments.
+> The project is divided into three conceptual environments.
+
 ### Development
 
 #### Structure
@@ -62,7 +65,7 @@ The staging environment is deployed on Heroku. It is composed of one app running
 
 #### Running
 
-`stem-c-staging` is automatically built from the latest commits to `develop`. Heroku runs the container orchestration from there.
+`stem-c-staging` is automatically built from the latest commits to `release`. Heroku runs the container orchestration from there.
 
 ### Production
 
@@ -99,20 +102,33 @@ heroku container:release web
 
 ### Git Flow 
 
-![Git Flow](https://nvie.com/img/git[email protected])
+> We will follow this git flow for the most part — instead of individual release branches, we will have one to streamline staging deployment 
 
-Ideally, we want our flow to resemble this. Master and develop are locked for direct commits. All commits must be made to a non-protected branch and submitted via a pull request with one approving review.
+![Git Flow](https://nvie.com/img/[email protected])
 
 ### Branches
 
-- `master` - Production application
-- `release/<version>` - Staged version
-- `develop` - Working version of the application
-- `feature/<scaffold>-<feature-name>` - Based off of develop
-  - ex. `feature/cms-strapi`
-- `hotfix/<scaffold>-<fix-name>` - Based off of master
-  - ex. hotfix/client-cors
+#### Protected
+
+> Locked for direct commits — all commits must be made from a non-protected branch and submitted via a pull request with one approving review
+
+- **master** - Production application
+
+#### Non-protected
+
+> Commits can be made directly to the branch
+
+- **release** - Staging application
+- **develop** - Working version of the application
+- **feature/<`scaffold`>-<`feature-name`>** - Based off of develop
+  - ex. **feature/cms-strapi**
+- **hotfix/<`scaffold`>-<`fix-name`>** - Based off of master
+  - ex. **hotfix/client-cors**
 
 ### Pull Requests
 
-Before submitting a pull request, merge the target branch into the working branch to resolve any merge conflicts. Include a description of the changes made.
+> PRs to **master** should squash and merge
+>
+> PRs to all other branches should create a merge commit
+
+Before submitting a pull request, merge the target branch into the working branch to resolve any merge conflicts. Include a description of the changes made.

cms/README.md

@@ -1,6 +1,6 @@
 # Cms
 
-REST API and admin portal that comprise the backend. It is powered by [Node](https://nodejs.org/en/), [Strapi](https://strapi.io/documentation/3.0.0-beta.x/getting-started/introduction.html), and [PostgreSQL](https://www.postgresql.org/). The file structure is defined by Strapi and is documented [here](https://strapi.io/documentation/3.0.0-beta.x/concepts/file-structure.html#files-structure).
+> REST API and admin portal that comprise the backend. It is powered by [Node](https://nodejs.org/en/), [Strapi](https://strapi.io/documentation/3.0.0-beta.x/getting-started/introduction.html), and [PostgreSQL](https://www.postgresql.org/). The file structure is defined by Strapi and is documented [here](https://strapi.io/documentation/3.0.0-beta.x/concepts/file-structure.html#files-structure).
 
 <br/>
 
@@ -24,7 +24,7 @@ Additional scripts:
 
 ## API `/`
 
-Built with [Node](https://nodejs.org/en/), [Koa](https://github.com/koajs/koa#readme), and [Bookshelf](https://bookshelfjs.org/), the REST API enables CRUD functionality with the application's content. Authentication is enabled via JWTs. The dbms is [PostgreSQL](https://www.postgresql.org/).
+> Built with [Node](https://nodejs.org/en/), [Koa](https://github.com/koajs/koa#readme), and [Bookshelf](https://bookshelfjs.org/), the REST API enables CRUD functionality with the application's content. Authentication is enabled via JWTs. The dbms is [PostgreSQL](https://www.postgresql.org/).
 
 ### Entity Relationships
 

compile/README.md

@@ -1,6 +1,6 @@
 # Compile
 
-Arduino compilier server.
+> Arduino compilier server.
 
 <br/>
 
@@ -23,7 +23,7 @@ Additional scripts:
 
 ## API
 
-The interface for this service is simple. There are three informational endpoints and one endpoint for compiling arduino code.
+> The interface for this service is simple. There are three informational endpoints and one endpoint for compiling arduino code.
 
 | Method | Path       | Description                                   |
 | ------ | ---------- | --------------------------------------------- |