| 1 | # Maintainers
|
| 2 | This repo is currently maintained by Ken Liao (@yknl).
|
| 3 |
|
| 4 | # Issues
|
| 5 | Github issues marked [help-wanted](https://github.com/blockstack/blockstack.js/labels/help-wanted)
|
| 6 | are great places to start. Please ask in a github issue or slack before embarking
|
| 7 | on larger issues that aren't labeled as help wanted or adding additional
|
| 8 | functionality so that we can make sure your contribution can be included!
|
| 9 |
|
| 10 | # Pull Request
|
| 11 |
|
| 12 | ## Submitting
|
| 13 | This repository uses the [git flow branching mode](http://nvie.com/posts/a-successful-git-branching-model/).
|
| 14 |
|
| 15 | The latest released code as deployed to npm is in `master` and the latest delivered development
|
| 16 | changes for the next release are in `develop`.
|
| 17 |
|
| 18 | We use the [git-flow-avh](https://github.com/petervanderdoes/gitflow-avh) plugin.
|
| 19 |
|
| 20 | Pull request requirements:
|
| 21 |
|
| 22 | 1. Describe exactly what the goal of the PR is (and link to any relevant issues)
|
| 23 | 2. Describe how that goal was achieved through the submitted implementation.
|
| 24 | 3. The code must be lint-free and pass the unit tests by running `$ npm run test`
|
| 25 | 4. The code should contain [flow static type annotations](https://flow.org)
|
| 26 | 5. Contain tests that cover any and all new functionality or code changes.
|
| 27 | 6. Describe how the new functionality can be tested manually.
|
| 28 | 7. Document any new features or endpoints, and describe how developers would be expected to interact with them.
|
| 29 | 8. PR authors should agree to our contributor's agreement.
|
| 30 |
|
| 31 | ## Reviewers
|
| 32 | Ken Liao (@yknl)
|
| 33 | Hank Stoever (@hstove)
|
| 34 | Aaron Blankstein (@kantai)
|
| 35 | Matthew Little (@zone117x)
|
| 36 |
|
| 37 | All pull requests require at least 2 reviewer approvals before it can be merged.
|
| 38 |
|
| 39 | # Documentation
|
| 40 | 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.
|
| 41 |
|
| 42 | # Reviewing Pull Requests
|
| 43 | A PR reviewer is responsible for ensuring the following:
|
| 44 |
|
| 45 | 1. All code changes are covered by automated tests.
|
| 46 |
|
| 47 | 2. Authentication and Gaia storage continues to work properly when integrated in both the Blockstack Browser and apps.
|
| 48 |
|
| 49 | 3. Compatibility breaking changes are documented. |
| \ | No newline at end of file |