Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.46 KB

DEVELOPING.md

File metadata and controls

37 lines (28 loc) · 1.46 KB
Raw

Developer Manual

Tasks

  • yarn run build Build the contracts, client bindings and compile with typescript.
  • yarn run test Rebuild the contract and client bindings and run all tests.
  • yarn run lint Check with prettier and solhint. The tasks lint:solhint and lint:prettier are also available.

Changelog and versioning

The project follows Semantic Versioning with regard to its JavaScript and TypeScript bindings' APIs and the Ethereum ABI. Any changes visible through any of these interfaces must be noted in the changelog and reflected in the version number when a new release is made. The changelog is manually updated in every commit that makes a change and it follows the Keep a Changelog convention.

Releasing a new version

Whenever a new version is released, a separate commit is created. It contains all the version bumping work, which is:

  • Wrap up the changes for the new version in CHANGELOG.md and open a new Unreleased version.
  • Bump version in package.json

The version bumping commit is the head of the branch merged into master. The branch must be rebased and mergeable using the fast-forward option. After the merge is finished, the masters head is tagged with a git tag and a GitHub release. Both of them are named using the version number with a v prefix, e.g. v0.0.1, v1.0.0, v1.2.3 or v1.0.0-alpha.