From 5e8c50e970438b4eba3b508fb0cf93940bd4be18 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Mon, 16 Mar 2020 09:51:55 +0000 Subject: [PATCH] simplifies code contributions by fully automating the setup with gitpod. --- .gitpod.yml | 2 ++ CONTRIBUTING.md | 15 ++++++++++++--- README.md | 4 +++- 3 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000..2b06da22 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,2 @@ +tasks: + - init: npm install diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3cb278df..d54be0e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,15 @@ Super exciting to see your contribution! #### How do I contribute code? +##### Contribute using one click online setup + +You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically: + +- clone the bundle-size repo. +- install all the dependencies. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) + 1. Fork this repo on github. 2. Clone it on your machine: `git clone https://github.com/YOUR_USERNAME/bundlesize.git` @@ -25,7 +34,7 @@ Super exciting to see your contribution! 4. Run `npm test` to ensure the repository is setup correctly. You should see a dummy output: ``` -PASS ./index.js: 189B < maxSize 600B gzip +PASS ./index.js: 189B < maxSize 600B gzip ``` 5. Make your changes. @@ -58,7 +67,7 @@ API is hosted on zeit/now. - `store/firebase.js` Fetches and updates values from firebase #### [Click here to join the slack channel](https://join.slack.com/t/bundlesize/shared_invite/MjMyNTA0NjUwNzg5LTE1MDM4NjAxNjEtMjFjZThlZmIxMw) - + #### Doubts? Feel free to open an issue or reach out to me [on twitter](https://twitter.com/siddharthkp). @@ -99,4 +108,4 @@ Thank you to all our sponsors! (please ask your company to also support this ope - \ No newline at end of file + diff --git a/README.md b/README.md index f89c5d96..2514a220 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +



@@ -10,6 +11,7 @@ [![Build Status](https://travis-ci.org/siddharthkp/bundlesize.svg?branch=master)](https://travis-ci.org/siddharthkp/bundlesize) [![NPM Version](https://img.shields.io/npm/v/bundlesize.svg)](https://npmjs.org/package/bundlesize) [![NPM Downloads](https://img.shields.io/npm/dm/bundlesize.svg?style=flat)](https://www.npmjs.com/package/bundlesize) +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/siddharthkp/bundlesize)   #### Setup @@ -189,7 +191,7 @@ Using a different CI? You will need to supply an additional 5 environment variab - `CI_REPO_NAME` given the repo `https://github.com/myusername/myrepo` would be `myrepo` - `CI_COMMIT_MESSAGE` the commit message - `CI_COMMIT_SHA` the SHA of the CI commit, in [Jenkins](https://jenkins.io/) you would use `${env.GIT_COMMIT}` -- `CI=true` usually set automtically in CI enviroments +- `CI=true` usually set automtically in CI enviroments (Ask me for help if you're stuck)