-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added satoshi view helper to convert satoshi to other unit e.g. bitco…
…in, updated docs
- Loading branch information
Sandro Keil
committed
Jun 27, 2014
1 parent
2481ab4
commit 0f65315
Showing
11 changed files
with
492 additions
and
15 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
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 |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# CONTRIBUTING | ||
|
||
## RESOURCES | ||
|
||
If you wish to contribute to Zend Framework, please be sure to read to the following resources: | ||
|
||
- Coding Standards: [PSR-0/1/2/4](https://github.com/php-fig/fig-standards/tree/master/accepted) | ||
- Git Guide: [README-GIT.md](README-GIT.md) | ||
|
||
If you are working on new features, or refactoring an existing | ||
component, please create a proposal. You can do this in on the RFC's | ||
page, https://github.com/sandrokeil/BlockchainWalletApi/wiki/RFCs. | ||
|
||
## RUNNING TESTS | ||
|
||
To run tests: | ||
|
||
- Make sure you have a recent version of PHPUnit installed; 3.7.0 | ||
minimally. | ||
- Be sure you are in the root directory | ||
- Execute PHPUnit | ||
|
||
```sh | ||
% phpunit | ||
``` | ||
|
||
You can turn on conditional tests with the TestConfig.php file. | ||
To do so: | ||
|
||
- Enter the `test/` subdirectory. | ||
- Copy `TestConfig.php.dist` file to `TestConfig.php` | ||
- Edit `TestConfig.php` to enable any specific functionality you want to test, as well as to provide test values to | ||
utilize. |
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 |
---|---|---|
@@ -0,0 +1,116 @@ | ||
# USING THE GIT REPOSITORY | ||
|
||
## Setup your own public github repository | ||
|
||
Your first step is to establish a public repository from which i can pull your work into the master repository. | ||
|
||
1. Setup a GitHub account (http://github.com/), if you haven't yet | ||
2. Fork the BlockchainWalletApi repository (http://github.com/sandrokeil/BlockchainWalletApi) | ||
3. Clone your fork locally and enter it (use your own GitHub username in the statement below) | ||
|
||
```sh | ||
% git clone git@github.com:<username>/BlockchainWalletApi.git | ||
% cd BlockchainWalletApi | ||
``` | ||
|
||
4. Add a remote to the canonical BlockchainWalletApi repository, so you can keep your fork | ||
up-to-date: | ||
|
||
```sh | ||
% git remote add upstream https://github.com/sandrokeil/BlockchainWalletApi.git | ||
% git fetch upstream | ||
``` | ||
|
||
## Keeping Up-to-Date | ||
|
||
Periodically, you should update your fork to match the canonical BlockchainWalletApi repository. we have | ||
added a remote to the BlockchainWalletApi repository, which allows you to do the following: | ||
|
||
```sh | ||
% git checkout master | ||
% git pull upstream master | ||
- OPTIONALLY, to keep your remote up-to-date - | ||
% git push origin | ||
``` | ||
|
||
If you're tracking other branches -- for example, the "develop" branch, where new feature development occurs -- | ||
you'll want to do the same operations for that branch; simply substitute "develop" for "master". | ||
|
||
## Working on BlockchainWalletApi | ||
|
||
When working on BlockchainWalletApi, we recommend you do each new feature or bugfix in a new branch. This simplifies the | ||
task of code review as well as of merging your changes into the canonical repository. | ||
|
||
A typical work flow will then consist of the following: | ||
|
||
1. Create a new local branch based off your master branch. | ||
2. Switch to your new local branch. (This step can be combined with the previous step with the use of `git checkout -b`.) | ||
3. Do some work, commit, repeat as necessary. | ||
4. Push the local branch to your remote repository. | ||
5. Send a pull request. | ||
|
||
The mechanics of this process are actually quite trivial. Below, we will create a branch for fixing an issue in the tracker. | ||
|
||
```sh | ||
% git checkout -b 3452 | ||
Switched to a new branch '3452' | ||
``` | ||
... do some work ... | ||
|
||
```sh | ||
% git commit | ||
``` | ||
... write your log message ... | ||
|
||
```sh | ||
% git push origin HEAD:3452 | ||
Counting objects: 38, done. | ||
Delta compression using up to 2 threads. | ||
Compression objects: 100% (18/18), done. | ||
Writing objects: 100% (20/20), 8.19KiB, done. | ||
Total 20 (delta 12), reused 0 (delta 0) | ||
To ssh://git@github.com/sandrokeil/BlockchainWalletApi.git | ||
g5342..9k3532 HEAD -> master | ||
``` | ||
|
||
You can do the pull request from github. Navigate to your repository, select the branch you just created, and then | ||
select the "Pull Request" button in the upper right. Select the user "sandrokeil" as the recipient. | ||
|
||
### What branch to issue the pull request against? | ||
|
||
Which branch should you issue a pull request against? | ||
|
||
- For fixes against the stable release, issue the pull request against the "master" branch. | ||
- For new features, or fixes that introduce new elements to the public API | ||
(such as new public methods or properties), issue the pull request against the "develop" branch. | ||
|
||
## Branch Cleanup | ||
|
||
As you might imagine, if you are a frequent contributor, you'll start to get a ton of branches both locally and on | ||
your remote. | ||
|
||
Once you know that your changes have been accepted to the master repository, we suggest doing some cleanup of these | ||
branches. | ||
|
||
- Local branch cleanup | ||
|
||
```sh | ||
% git branch -d <branchname> | ||
``` | ||
|
||
- Remote branch removal | ||
|
||
```sh | ||
% git push origin :<branchname> | ||
``` | ||
|
||
|
||
## FEEDS AND EMAILS | ||
|
||
RSS feeds may be found at: | ||
|
||
`https://github.com/sandrokeil/BlockchainWalletApi/commits/<branch>.atom` | ||
|
||
where <branch> is a branch in the repository. | ||
|
||
To subscribe to git email notifications, simply watch or fork the BlockchainWalletApi repository on GitHub. |
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
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
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
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 |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<?php | ||
/** | ||
* Sake | ||
* | ||
* @link http://github.com/sandrokeil/BlockchainWalletApi for the canonical source repository | ||
* @copyright Copyright (c) 2014 Sandro Keil | ||
* @license http://github.com/sandrokeil/BlockchainWalletApi/blob/master/LICENSE.txt New BSD License | ||
*/ | ||
|
||
return array( | ||
'invokables' => array( | ||
'satoshi' => '\Sake\BlockchainWalletApi\View\Helper\Satoshi', | ||
), | ||
); |
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
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
Oops, something went wrong.