Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
siddharthkp committed Jul 11, 2017
1 parent c53bd7d commit 148ddc8
Showing 1 changed file with 0 additions and 47 deletions.
47 changes: 0 additions & 47 deletions CONTRIBUTING.md
Expand Up @@ -42,53 +42,6 @@ PASS ./index.js: 189B < maxSize 600B gzip

#### Structure

- `index.js` This is the root file which get's executed.

- src
Hi! Thanks for giving this a read!

Super exciting to see your contribution!

&nbsp;

#### Can I implement feature X?

1. Before writing the code for your feature, please [create an issue here](https://github.com/siddharthkp/bundlesize/issues/new?labels=feature%20request).

2. Sometimes, the feature you have in mind might already exist! or might not fit well in the tool.

3. It breaks my heart to say no to a pull request. So, please let's talk about it first on an issue!

&nbsp;

#### How do I contribute code?

1. Fork this repo on github.

2. Clone it on your machine: `git clone https://github.com/YOUR_USERNAME/bundlesize.git`

3. Run `npm install`

4. Run `npm test` to ensure the repository is setup correctly. You should see a dummy output:

```
PASS ./index.js: 189B < maxSize 600B gzip
```

5. Make your changes.

6. Make sure that the tests still pass: `npm test`

7. Submit a pull request to the original bundlesize repository through GitHub.

8. Choose a nice title and describe the changes you have made.

9. Do a little dance!

&nbsp;

#### Structure

- `index.js` This is the root file

- `src/config.js` Reads bundlesize settings from package.json
Expand Down

0 comments on commit 148ddc8

Please sign in to comment.