kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-04-28 17:25:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update contributing doc

Browse Source
This commit is contained in:
janniks
2023-04-12 13:20:44 -06:00
committed by janniks
parent 89dc78791b
commit 5a327eb7ea
1 changed files with 9 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
CONTRIBUTING.md
View File

@@ -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.