Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 1.36 KB

Design and Development notes for Contributors

Code style and quality

Style is based on Airbnb's JS style guide. We recommend vs-code with "lint on save".

Contributions should pass npm run lint.

We use ES6 modules, thanks to webpack.

We try to use @ts-check, that is: typescript checking of JSDoc comments.

RChain APIs

We're using a fork of @tgrospic/rnode-client-js as a git submodule. Use git submodule update --init.

We're also thinking about using an update of rchain-community/RChain-API.

Web Dev: bootstrap, mithril

plus

  • shepherd.js
  • htm

Continuous deployment with Netlify

... is under dckc's account.

Roads not taken

The current edb6ec3 rev results from porting work from https://github.com/rchain-community/rnode-client-js/tree/ballot-ui git format-patch e4d97ee..c480f4c

after rebasing away history of other designs:

  • o2r thru e76e7b64cdc2
  • rchat thru cb1055f75c91
  • webui thru 252964964f08

We've migrated from flow comments to typescript.

For bundlers, snowpack looked pretty cool but was a bit flakey so we've switched to webpack.