Skip to content

Commit 5e8c50e

Browse files
committed
simplifies code contributions by fully automating the setup with gitpod.
1 parent 0f241c8 commit 5e8c50e

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

.gitpod.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
tasks:
2+
- init: npm install

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@ Super exciting to see your contribution!
1616

1717
#### How do I contribute code?
1818

19+
##### Contribute using one click online setup
20+
21+
You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:
22+
23+
- clone the bundle-size repo.
24+
- install all the dependencies.
25+
26+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
27+
1928
1. Fork this repo on github.
2029

2130
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!
2534
4. Run `npm test` to ensure the repository is setup correctly. You should see a dummy output:
2635

2736
```
28-
PASS ./index.js: 189B < maxSize 600B gzip
37+
PASS ./index.js: 189B < maxSize 600B gzip
2938
```
3039

3140
5. Make your changes.
@@ -58,7 +67,7 @@ API is hosted on zeit/now.
5867
- `store/firebase.js` Fetches and updates values from firebase
5968

6069
#### [Click here to join the slack channel](https://join.slack.com/t/bundlesize/shared_invite/MjMyNTA0NjUwNzg5LTE1MDM4NjAxNjEtMjFjZThlZmIxMw)
61-
70+
6271
#### Doubts?
6372

6473
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
99108
<a href="https://opencollective.com/bundlesize/sponsor/6/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/6/avatar.svg"></a>
100109
<a href="https://opencollective.com/bundlesize/sponsor/7/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/7/avatar.svg"></a>
101110
<a href="https://opencollective.com/bundlesize/sponsor/8/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/8/avatar.svg"></a>
102-
<a href="https://opencollective.com/bundlesize/sponsor/9/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/9/avatar.svg"></a>
111+
<a href="https://opencollective.com/bundlesize/sponsor/9/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/9/avatar.svg"></a>

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
<p align="center">
23
<img src="https://cdn.rawgit.com/siddharthkp/bundlesize/master/art/logo.png" height="200px">
34
<br><br>
@@ -10,6 +11,7 @@
1011
[![Build Status](https://travis-ci.org/siddharthkp/bundlesize.svg?branch=master)](https://travis-ci.org/siddharthkp/bundlesize)
1112
[![NPM Version](https://img.shields.io/npm/v/bundlesize.svg)](https://npmjs.org/package/bundlesize)
1213
[![NPM Downloads](https://img.shields.io/npm/dm/bundlesize.svg?style=flat)](https://www.npmjs.com/package/bundlesize)
14+
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/siddharthkp/bundlesize)
1315
&nbsp;
1416

1517
#### Setup
@@ -189,7 +191,7 @@ Using a different CI? You will need to supply an additional 5 environment variab
189191
- `CI_REPO_NAME` given the repo `https://github.com/myusername/myrepo` would be `myrepo`
190192
- `CI_COMMIT_MESSAGE` the commit message
191193
- `CI_COMMIT_SHA` the SHA of the CI commit, in [Jenkins](https://jenkins.io/) you would use `${env.GIT_COMMIT}`
192-
- `CI=true` usually set automtically in CI enviroments
194+
- `CI=true` usually set automtically in CI enviroments
193195

194196
(Ask me for help if you're stuck)
195197

0 commit comments

Comments
 (0)