tx-result / Readme • Contributing • Changelog

Contributing

Welcome to new contributors! This project is open to input & edits.

Bug Reports & Feature Requests

Please use the dedicated form.

Pull Requests

Fork js-tx-result.
Commit your changes to the fork.
Create a pull request.

If you want to implement a new feature, please get in touch first: Keybase, Telegram, Email.

Project Structure

es5/: JS transpiled code (generated at build time, not commited).
src/: JS source code.
static/: Static files, added to web/ at build time.
test/: Test suite.
web/: JS bundled code (generated at build time, commited in a submodule).

Workflow

Clone:

git clone https://git.cosmic.plus/js-tx-result
cd js-tx-result
npm run get

Commit:

npm run test
npm run lint
git ci ...

Please sign your commits with your PGP key.

Release:

First of all update the package version into package.json.

export version={semver}
npm run make-release
npm run publish-release

Please sign your commits and tags with your PGP key.

Scripts

Those helpers require a POSIX shell.

npm run get: Fetch the web sub-repository.
npm run test: Run the test suite.
npm run lint: Lint code.
npm run clean: Clean the web/ directory.
npm run watch: Automatically transpile & bundle code after each change.
npm run build: Build the production transpiled code & browser bundle.
npm run check: Check the production browser bundle integrity.
version={semver} npm run make-release: Build & locally commit release.
version={semver} npm run publish-release: Check, tag, push & publish release.