-
Notifications
You must be signed in to change notification settings - Fork 310
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,14 @@ | ||
# Maintainers | ||
This repo is currently maintained by Ken Liao (@yknl). | ||
## Issues | ||
|
||
# Issues | ||
Github issues marked [help-wanted](https://github.com/blockstack/blockstack.js/labels/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! | ||
Github issues marked [help-wanted](https://github.com/hirosystems/stacks.js/labels/help%20wanted) 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! | ||
|
||
# Pull Request | ||
## Pull Requests | ||
|
||
## Submitting | ||
This repository uses the [git flow branching mode](http://nvie.com/posts/a-successful-git-branching-model/). | ||
Please follow [conventional commits](https://www.conventionalcommits.org/) when writing commit messages. | ||
|
||
The latest released code as deployed to npm is in `master` and the latest delivered development | ||
changes for the next release are in `develop`. | ||
A pull request reviewer is responsible for ensuring the following: | ||
|
||
We use the [git-flow-avh](https://github.com/petervanderdoes/gitflow-avh) plugin. | ||
|
||
Pull request requirements: | ||
|
||
1. Describe exactly what the goal of the PR is (and link to any relevant issues) | ||
2. Describe how that goal was achieved through the submitted implementation. | ||
3. The code must be lint-free and pass the unit tests by running `$ npm run test` | ||
4. The code should contain [flow static type annotations](https://flow.org) | ||
5. Contain tests that cover any and all new functionality or code changes. | ||
6. Describe how the new functionality can be tested manually. | ||
7. Document any new features or endpoints, and describe how developers would be expected to interact with them. | ||
8. PR authors should agree to our contributor's agreement. | ||
|
||
## Reviewers | ||
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 | ||
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. | ||
|
||
# Reviewing Pull Requests | ||
A PR reviewer is responsible for ensuring the following: | ||
|
||
1. All code changes are covered by automated tests. | ||
|
||
2. Authentication and Gaia storage continues to work properly when integrated in both the Blockstack Browser and apps. | ||
|
||
3. Compatibility breaking changes are documented. | ||
1. Commit messages are reasonable for changelogs (otherwise squash commit the pull request with a single new message). | ||
1. Important code changes are covered by automated tests. | ||
1. Compatibility breaking changes are documented and covered by conventional commits. |
5a327eb
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
stacksjs-docs – ./
stacksjs.vercel.app
stacks.js.org
stacksjs-docs-blockstack.vercel.app
stacks-js.vercel.app
stacksjs-docs-git-master-blockstack.vercel.app