From 99610da8a1549963f5a07e6fd6c5b5051e52d068 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Sat, 24 Oct 2020 17:11:30 +0000 Subject: [PATCH] make contributions easier with the online development setup. --- .gitpod.yml | 6 ++++++ CONTRIBUTING.md | 6 ++++++ README.md | 1 + 3 files changed, 13 insertions(+) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..b1b478186 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,6 @@ +tasks: + - init: yarn install && yarn bootstrap + +vscode: + extensions: + - esbenp.prettier-vscode@5.7.1:GDba64T6G+TUi1qmc6BE3A== \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48d152bde..20a231772 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,12 @@ Follow these steps to get your code PR-ready: 6. Update `CHANGELOG.md`. 7. Ensure your changes build by running `yarn build` in the appropriate package directory(s). +## Online one-click setup + +You can use Gitpod(an online IDE which is free for Open Source) for working on issues and making PRs online. With a single click it will launch a workspace and automatically: clone the `popmoton` repo and run `yarn install` && `yarn bootstrap` so that anyone interested can start straight away. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) + ## Codebase Overview Other than [Stylefire](https://github.com/popmotion/stylefire) and [Framesync](https://github.com/popmotion/framesync), Popmotion is a monorepo. All Popmotion and Pose packages are contained in the [`packages` directory](https://github.com/Popmotion/popmotion/tree/master/packages). diff --git a/README.md b/README.md index 4570fd54c..2216e88d7 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![npm version](https://img.shields.io/npm/v/popmotion.svg?style=flat-square)](https://www.npmjs.com/package/popmotion) [![npm downloads](https://img.shields.io/npm/dm/popmotion.svg?style=flat-square)](https://www.npmjs.com/package/popmotion) [![Twitter Follow](https://img.shields.io/twitter/follow/popmotionjs.svg?style=social&label=Follow)](http://twitter.com/popmotionjs) +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) Popmotion is: - **Powerful**: It supports keyframe and spring animations for numbers, colors and complex strings.