Skip to content

Latest commit

 

History

History
114 lines (75 loc) · 3.44 KB

developer-guide.md

File metadata and controls

114 lines (75 loc) · 3.44 KB
Raw

Developer Guide

All information regarding contributing to and progressing ethjs-filter module can be found in this document.

Install

npm install --save ethjs-filter

Install from Source

git clone http://github.com/ethjs/ethjs-filter
npm install

Test

npm test

Build

npm run build

Linting

npm run lint

Test coverage

Note, this will generate a coverage report locally.

npm run test:coverage

You can find the coveralls report and view the percentages and stats, by going to the index.html file generated after running the script. Open this in a web browser to see the generated report.

Build Staging

The build staging for this module is as follows:

  1. Cleanup
  2. Linting
  3. Testing
  4. Babel processing (output to lib)
  5. Webpack (output to dist)
  6. Webpack production (output to dist)
  7. Retest lib folder for babel processing solidity
  8. Report build stats

Folder Structure

All module source code is found in the src directory. All module helper scripts can be found in the scripts folder. These will not need to be touched, and are purely configuration for this repository.

./ethjs-filter
  ./.github
  ./dist
  ./lib
    ./tests
  ./internals
    ./webpack
  ./coverage
  ./docs
  ./src
    ./tests

Note, the ./lib dir is generated from the babel build staging. ./coverage is generated from the npm run test:coverage script. All internals and helper scripts (i.e. webpack) are in ./internals. All distribution builds are in ./dist (usually a minified and unminified production build of the package).

NPM Practice

Across all ethjs- repos, we enforce version hardening (i.e. "0.0.3" not "^0.0.3"). We want to reduce potential hazardous install changes from dependancies as much as possible to ensure package preformace, testing, security and design. Please make sure all your commits and PR's are version hardend if you are installing or removing new packages.

After build staging it is the lib folder which actually gets published to NPM. This allows for easy inclusion into other modules which may not use babel transpiling or which may not support es2015+.

NPM/Node Version Requirements

ethjs requires you have:

  • nodejs -v 6.5.0+
  • npm -v 3.0+

This is a requirement to run, test, lint and build this module.

Webpack

ethjs uses webpack across all its browser focused repos. Webpack is used to package down project files into distribution builds for the browser. You can see the builds it produces by going to the dist folder.

Read more about webpack here: https://github.com/webpack/docs

Changelog

All relevant changes are notated in the CHANGELOG.md file, moniter this file for changes to this repository.

Test-coverage practice

Across all ethjs- repos, we enforce mandatory test coverage. We never commit to main. As a general policy, coverage results must always be above 95% for any ethjs- PR or commit. We want to ensure complete coverage across the board.

Contributing

Please help better the ecosystem by submitting issues and pull requests. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard. Please read more about contributing to ethjs-filter in the .github/CONTRIBUTING.md.

Licence

This project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.