Merge pull request #886 from cmu-delphi/sgratzl/contributing

docs: update release process and contributing guide

Author: sgratzl

.github/CONTRIBUTING.md

@@ -25,36 +25,6 @@ The discussion / comments within an issue should restrict to the topic of the is
 
 Issues are assigned to a single user which is responsible for the implementation of the issue eventually leading to a pull request.
 
-## Project Board
-
-The main project board is located at https://github.com/cmu-delphi/www-covidcast/projects/2.
-
-The columns have the following meaning:
-
-- `To Do`
-
-  contains newly created issues that needs still to be evaluated and discussed and not yet ready to be implemented
-
-- `Up Next`
-
-  contains assigned issues that should be implemented next. The top most issue has the highest priority
-
-- `In Progress`
-
-  once a developer starts working on an issue he/she should move the issue from the `Up Next` to the `In Progress` column indicating that it is currently implemented
-
-- `In Review`
-
-  after creating the pull request for an issue the pull request card as well as the corresponding issue card are moved to the `In Review` column indicating that they can be reviewed and tested.
-
-- `Done`
-
-  after merging the pull request, the pull request and issue cards can be moved to the `Done` column
-
-- `Icebox`
-
-  the `Icebox` column contains issues that open for discussion, have no specific plan, or longer future ideas
-
 ## Pull Requests
 
 The purpose of a pull request is to merge the solution to an existing issue into the current `dev` branch.

.gitpod.yml

@@ -0,0 +1,10 @@
+tasks:
+  - init: npm install
+  - command: npm start
+ports:
+  - port: 8080
+vscode:
+  extensions:
+    - dbaeumer.vscode-eslint
+    - esbenp.prettier-vscode
+    - svelte.svelte-vscode

README.md

@@ -10,51 +10,71 @@ The next `dev` version is deployed at https://dev--cmu-delphi-covidcast.netlify.
 
 ## Figma Mock-Ups
 
-Located at: https://www.figma.com/file/CZ3YwWBL2md9j39qdcBfDs/COVIDCast?node-id=0%3A1
+Located at: [Figma Delphi-Site-Redesign](https://www.figma.com/file/IiYu74VmEi4GVS4bnYaTd6/Delphi-Site-Redesign).
 
 ## Development Environment
 
+One click solution: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/cmu-delphi/www-covidcast)
+
 `node` and `npm` are required for development.
 
 To begin development, clone this repository and run
 
-`npm install`
+```sh
+npm install
+```
 
 To lint or check for styling, run
 
-`npm run lint`
+```sh
+npm run lint
+```
 
 To run unit test, run
 
-`npm run test`
+```sh
+npm test
+```
 
 To run e2e test, run
 
-`npm run build && npm run test:e2e`
+```sh
+npm run build
+```
 
 To run the development server, run
 
-`npm start`
+```sh
+npm start
+```
 
-the website should open automatically.
+the website is then accessible via: http://localhost:8080/
 
 To run e2e test against the development server, run
 
-`npm start`
+```sh
+npm start
+```
+
 in a separate shell:
 
-`npm run cy:open`
+```sh
+npm run cy:open
+```
 
 ### Release Process
 
-To create a release, run
-
-1. create a release branch `release-vX.X.X` and push to origin
-1. run `npm run release` and publish the release
-1. create a PR that merges the `release` branch in the `main` branch
-1. create a PR that merges the `main` branch back into the `dev` branch
-
-Then go to the release page and update short description of the changes made.
+The release consists of multiple stets which can be all done via the GitHub website:
+
+1. Go to [create_release GitHub Action](https://github.com/cmu-delphi/www-covidcast/actions/workflows/create_release.yml) and click the `Run workflow` button. Enter the next version number or one of the magic keywords (patch, minor, major) and hit the green `Run workflow` button.
+1. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/www-covidcast/pulls)
+1. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully
+1. Once approved and merged, another GitHub action job starts which automatically will
+   1. create a git tag
+   1. create another [Pull Request](https://github.com/cmu-delphi/www-covidcast/pulls) to merge the changes back to the `dev` branch
+   1. create a [GitHub release](https://github.com/cmu-delphi/www-covidcast/releases) with automatically derived release notes
+   1. create a [Pull Request in www-main](https://github.com/cmu-delphi/www-main/pulls) to update the website to the new release
+1. Done
 
 ## License