aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSam Potts <sam@potts.es>2020-03-29 11:22:20 +1100
committerGitHub <noreply@github.com>2020-03-29 11:22:20 +1100
commit39558cbabc76df1fc29fbe12d8f6b14ad01bb559 (patch)
treed8f371c10dfc744540d8c3735d12a71b21a98a2f
parentfcd82088a5cca625fea16fb60a30640468cb114b (diff)
parent10f366fe32348259c9bb15cfdb7feeffcb3f0278 (diff)
downloadplyr-39558cbabc76df1fc29fbe12d8f6b14ad01bb559.tar.lz
plyr-39558cbabc76df1fc29fbe12d8f6b14ad01bb559.tar.xz
plyr-39558cbabc76df1fc29fbe12d8f6b14ad01bb559.zip
Merge pull request #1731 from nisarhassan12/master
update the gitpod setup description to be more precise.
-rw-r--r--.gitpod.yml2
-rw-r--r--contributing.md10
2 files changed, 9 insertions, 3 deletions
diff --git a/.gitpod.yml b/.gitpod.yml
index ded36866..c4a67050 100644
--- a/.gitpod.yml
+++ b/.gitpod.yml
@@ -1,5 +1,5 @@
tasks:
- - init: npm install && npm i gulp -g
+ - before: npm install && npm i gulp -g
command: gulp
ports:
- port: 3000
diff --git a/contributing.md b/contributing.md
index b1bcc315..38884f3a 100644
--- a/contributing.md
+++ b/contributing.md
@@ -29,9 +29,15 @@ Please follow the instructions in our issue templates. Don't use github issues t
* To test locally, you can use the demo site. First make sure you have installed the dependencies with `npm install` or `yarn`. Run `gulp` to build and it will run a local web server for development and watch for any changes.
-### Online one-click setup
+### Online one-click setup for contributing
-Alternatively can also use Gitpod, a free online Visual Studio Code-like IDE. With a single click it will automatically launch a ready-to-code workspace with all the dependencies pre-installed, gulp watching for changes and the web server running, so that you can start coding straightaway.
+You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it will launch a workspace and automatically:
+
+- clone the plyr repo.
+- install the dependencies.
+- run `gulp` to the start the server.
+
+So that you can start straight away.
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)