Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

simplifies code contributions by fully automating the setup with gitpod. #354

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
15 changes: 12 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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.
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -99,4 +108,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