From 99cb48cd9aef76a591781b8376011b82e6c5f553 Mon Sep 17 00:00:00 2001 From: AtHeartEngineer <1675654+AtHeartEngineer@users.noreply.github.com> Date: Fri, 3 Jun 2022 12:39:53 -0400 Subject: [PATCH] Updated readme for contribution Updated readme with contribution instructions and a description of the build and deploy process --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 242a594..654dc4e 100644 --- a/README.md +++ b/README.md @@ -63,4 +63,10 @@ Create an [issue](https://github.com/AtHeartEngineering/pse_landingpage/issues/n ### Want to contribute? -Feel free to fork this repo and make a pull request! +Feel free to fork this repo and make a pull request to the `dev` branch. + +### Build and deployment process + +1. When a pull request or push is made to the `dev` branch, github actions builds a static/production version of the site to the `gh-pages-dev` branch. +2. Once changes have been verified on the `gh-pages-dev` branch, the `dev` branch is merged into `master` where github actions builds and deploys a production version of the site to `gh-pages` +3. `gh-pages` is served at [http://projects.appliedzkp.org](http://projects.appliedzkp.org)