Skip to content

Commit

Permalink
simplifies code contributions by fully automating the setup with gitpod.
Browse files Browse the repository at this point in the history
  • Loading branch information
nisarhassan12 committed Feb 11, 2020
1 parent 0f241c8 commit afd6b67
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
tasks:
- init: npm install
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ 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 one-click online setup, with a single click it will launch a ready to code workspace with the repo already cloned and all the dependencies pre-installed so that you can start straight away.

[![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`
Expand All @@ -25,7 +31,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.
Expand Down Expand Up @@ -58,7 +64,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).
Expand Down Expand Up @@ -99,4 +105,4 @@ Thank you to all our sponsors! (please ask your company to also support this ope
<a href="https://opencollective.com/bundlesize/sponsor/6/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/bundlesize/sponsor/7/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/bundlesize/sponsor/8/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/bundlesize/sponsor/9/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/9/avatar.svg"></a>
<a href="https://opencollective.com/bundlesize/sponsor/9/website" target="_blank"><img src="https://opencollective.com/bundlesize/sponsor/9/avatar.svg"></a>
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

<p align="center">
<img src="https://cdn.rawgit.com/siddharthkp/bundlesize/master/art/logo.png" height="200px">
<br><br>
Expand All @@ -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)
&nbsp;

#### Setup
Expand Down Expand Up @@ -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)

Expand Down

0 comments on commit afd6b67

Please sign in to comment.