The branch to be PR'd against will be master for the time being. This may change as the repo and contributors grow.
Branch names should start with `feature` or `fix` followed by `/description_of_branch`
```bash
# example
git branch feature/list-onchain-txs
```
Commit messages should start with `feature`, `fix`, or `test` followed by `(subject_of_commit)` and ending with `: description_of_commit`
```bash
#example
git commit -m "feature(list-onchain-txs): create hard code mock of onchain-txs list"
```
## eslint:
This project has eslint rules and PRs 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 and fix. With segwit activating soon and the demand for Zap rising rapid development will naturally leave some code untested but we should all try our best.
PRs should pass `npm run test` before they are merged
Zap is a free Lightning Network wallet focused on user experience and ease of use, with the overall goal of helping the cryptocurrency community scale Bitcoin and other cryptocurrencies.
@ -12,7 +15,7 @@ uses a Node.js proxy and,
Join us on [slack](https://join.slack.com/t/zaphq/shared_invite/MjI2MTY4NTcwMDUyLTE1MDI2OTA0ODAtNTRjMTY4YTNjNA) to discuss development, design and product
## Install
> For now Zap assumes you are running BTCD and LND (will change soon). Please see [installation](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md) to get that setup first
> For now Zap assumes you are running BTCD, LND and Zap Node.js (will change soon). Please see [installation](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md) for LND and Zap Node.js to get that setup first
* **Note: requires a node version >= 7 and an npm version >= 4.**
* **If you have installation or compilation issues, please file a Github issue**
@ -39,7 +42,10 @@ $ npm run test
$ npm run lint
```
## Current Todo List (Last updated August 15th)
## Contributing:
Please see the [contributing guide](https://github.com/LN-Zap/zap-desktop/CONTRIBUTING.md)
## Todos (Last updated August 16th):
Join us on [slack](https://join.slack.com/t/zaphq/shared_invite/MjI2MTY4NTcwMDUyLTE1MDI2OTA0ODAtNTRjMTY4YTNjNA) before tackling a todo to avoid duplicate work. This list will be updated daily to show what todos are being worked on
### Refactor
@ -50,6 +56,7 @@ Join us on [slack](https://join.slack.com/t/zaphq/shared_invite/MjI2MTY4NTcwMDUy
### Features
- [ ] Configurable BTCD + LN node connection (do not assume/rely on localhost)
- [ ] Error handling
- [ ] More tests
- [ ] List on-chain transactions
- [ ] Ability to search filter for payments
- [ ] Websocket handling for transactions
@ -70,14 +77,9 @@ Join us on [slack](https://join.slack.com/t/zaphq/shared_invite/MjI2MTY4NTcwMDUy
- [ ] Litecoin UI (pick out a silver main color)
- [ ] describegraph UI to see current status of the Lightning Network
### Testing
- [ ] Component tests
- [ ] Container tests
- [ ] API call tests
## Q & A (Quality and Assurance)
A good product not only has good software tests but also checks the quality of the UX/UI. Putting yourself in the shoes of the user will be very important for Zap.
A good product not only has good software tests but also checks the quality of the UX/UI. Putting ourselves in the shoes of a user will be very important for Zap.
If you see issues please report with screenshots and/or how to reproduce the bug/error
@ -87,26 +89,14 @@ If you see issues please report with screenshots and/or how to reproduce the bug
Jack Mallers
8 years ago