Skip to content

Commit

Permalink
Remove build section from js guidelines
Browse files Browse the repository at this point in the history
This is "completely out of date", according to @diasdavid in #225 (comment). I remove it here. What should go in its place?
  • Loading branch information
RichardLitt committed Feb 7, 2017
1 parent 607c2f2 commit d1e519b
Showing 1 changed file with 0 additions and 14 deletions.
14 changes: 0 additions & 14 deletions js-project-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Also, remember:
- [Guidelines](#guidelines)
- [Linting & Code Style](#linting--code-style)
- [Testing](#testing)
- [Building](#building)
- [Releasing](#releasing)
- [Commits](#commits)
- [Commit Message Format](#commit-message-format)
Expand Down Expand Up @@ -101,19 +100,6 @@ However, we've added an extra linting rule: Enforce the use of [strict mode](htt

Since `js-ipfs` is meant to be both a Node.js and Browser app, we strongly recommend having tests that run in both platforms, always. For most cases, we use [mocha](http://mochajs.org) to run write the tests and [karma](http://karma-runner.github.io) to automate the test execution in the browser. This solution has been extremely convenient.

### Building

In most IPFS JavaScript projects, we use [webpack](http://webpack.github.io/) for bundling the JavaScript. It adds a greater overhead when it comes to configuration, but this configuration can be reused since most projects share the same needs.

Where ES2015 is used, we managed to ensure that the code continues to run in every platform by transpiling it, if necessary, with [babel](http://babeljs.io/).

To make sure users can use the modules without having to transpile and shim the modules themselves, we've made the following available in most modules:

- __Raw ES2015 version__, ready to be consumed by platforms that understand Node.js based require and most of ES2015.
- __Raw ES5 version__, ready to be consumed by platforms that understand Node.js based require and ES5.
- __Concatenated ES5 version__, ready to be consumed by browsers through a script tag, where size does not matter.
- __Concatenated and minified ES5 version__, ready to be consumed by browsers through a script tag, where size matters.

### Releasing

Each time a new release happens, these are the steps we follow to make sure nothing gets left out:
Expand Down

0 comments on commit d1e519b

Please sign in to comment.