From 6e29f02f798405f7f70c076c5a82eb17d8f5eb27 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Mon, 16 Mar 2020 12:13:46 +0000 Subject: [PATCH] simplifies code contributions by fully automating the dev setup with gitpod. --- .gitpod.yml | 10 ++++++++++ README.md | 13 +++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..484b40150 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,10 @@ +tasks: + - init: yarn install + command: yarn run start +ports: + - port: 3000 + onOpen: open-preview + +vscode: + extensions: + - octref.vetur@0.23.0:0z6KpEz8h/vAvy4pYRDg3Q== \ No newline at end of file diff --git a/README.md b/README.md index 06abf4a09..94a666b2e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # tiptap A renderless and extendable rich-text editor for [Vue.js](https://github.com/vuejs/vue) +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/scrumpy/tiptap) [![](https://img.shields.io/npm/v/tiptap.svg?label=version)](https://www.npmjs.com/package/tiptap) [![](https://img.shields.io/npm/dm/tiptap.svg)](https://npmcharts.com/compare/tiptap?minimal=true) [![](https://img.shields.io/npm/l/tiptap.svg)](https://www.npmjs.com/package/tiptap) @@ -477,6 +478,18 @@ yarn build:packages yarn build:examples ``` +## Contribute using the online one-click setup + +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 `tiptap` repo. +- install the dependencies. +- run `yarn run start`. + +So that anyone interested in contributing can start straight away. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/scrumpy/tiptap/) + ## Contributing Please see [CONTRIBUTING](CONTRIBUTING.md) for details.