This repo is currently maintained by Ken Liao (@yknl).
Github issues marked help-wanted are great places to start. Please ask in a github issue or slack before embarking on larger issues that aren't labeled as help wanted or adding additional functionality so that we can make sure your contribution can be included!
This repository uses the git flow branching mode.
The latest released code as deployed to npm is in master and the latest delivered development
changes for the next release are in develop.
We use the git-flow-avh plugin.
Pull request requirements:
- Describe exactly what the goal of the PR is (and link to any relevant issues)
- Describe how that goal was achieved through the submitted implementation.
- The code must be lint-free and pass the unit tests by running
$ npm run test - The code should contain flow static type annotations
- Contain tests that cover any and all new functionality or code changes.
- Describe how the new functionality can be tested manually.
- Document any new features or endpoints, and describe how developers would be expected to interact with them.
- PR authors should agree to our contributor's agreement.
Ken Liao (@yknl) Hank Stoever (@hstove) Aaron Blankstein (@kantai) Matthew Little (@zone117x)
All pull requests require at least 2 reviewer approvals before it can be merged.
Documentation in this repo is automatically generated from code comments via documentation.js. It is the responsibility of the pull request author to verify documentation builds correctly.
A PR reviewer is responsible for ensuring the following:
-
All code changes are covered by automated tests.
-
Authentication and Gaia storage continues to work properly when integrated in both the Blockstack Browser and apps.
-
Compatibility breaking changes are documented.