lukechilds
/
zap-desktop
mirror of https://github.com/lukechilds/zap-desktop.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1056 Commits
9 Branches
5 Tags
147 MiB
 
 
 
Tree: 9847cdb82f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9847cdb82f'
${ noResults }
zap-desktop/CONTRIBUTING.md

1.5 KiB
Raw Blame History

Contributing

(Even after a recent refactor the code is still a bit sloppy, in a bit of a segwit rush, apologize in advance for any "wtf is this?")

Overview

Please join us on slack and check open issues to see what contributions are needed before tackling a task to avoid duplicate work.

Pull Requests

The master branch will be used for all pull requests for the time being. This may change as the repo and contributors grow.

Branch Names

Branch names should start with feature or fix followed by /description_of_branch.

Example

git branch feature/list-onchain-txs

Commit Messages

Commit messages should start with feature, fix, or test followed by (subject_of_commit) and ending with : description_of_commit.

Example

git commit -m "feature(list-onchain-txs): create hard code mock of onchain-txs list"

eslint

This project has eslint rules and pull requests should pass npm run lint before being merged. The eslint rules are not final by any means and can be changed if necessary

Tests

Tests should try to be written for every feature/fix and pass npm run test before being merged. With the demand for the Lightning Network and Zap rising, rapid development will naturally leave some code untested but we should all try our best.