From 5d428875fe3810ac4dced1a0d095283c825875c8 Mon Sep 17 00:00:00 2001 From: Tetiana Churikova Date: Thu, 29 Mar 2018 17:20:03 +0300 Subject: [PATCH] Update testing.md --- doc/testing.md | 54 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 39 insertions(+), 15 deletions(-) diff --git a/doc/testing.md b/doc/testing.md index 45404d7..20c61be 100644 --- a/doc/testing.md +++ b/doc/testing.md @@ -1,50 +1,62 @@ # Testing Open Bounty -We have a continuously deployed version tracking the `develop` branch live at https://openbounty.status.im:444. It uses the [Ropsten](https://ropsten.io/) Ethereum testnet. Any one is welcome to use it and your help with testing Open Bounty is greatly appreciated! +We have two environments for testing purposes: +* `staging` - where `develop` branch is continuously deployed -### General + **URL:** https://openbounty.status.im:444 + + **GitHub app:** https://github.com/apps/status-open-bounty-app-test + +* `testing`- where you can deploy and test separate pull requests + + **URL:** https://testing.openbounty.status.im + + **GitHub app:** https://github.com/apps/open-bounty-testing + +Both of them use the [Ropsten](https://ropsten.io/) Ethereum testnet. +Any one is welcome to use it and your help with testing Open Bounty is greatly appreciated! + + +## General For testing you will need: * a web browser (Chrome is known to work, testing with others appreciated) * an Ethereum account on the Ropsten testnet -* a Github account with administrative access to one or more repositories +* 2 Github accounts (one for Bounty Hunter, second - for Bounty Creator with administrative access to one or more repositories) * for approving bounty payouts you will additionally need access to an Ethereum wallet. ([MetaMask](https://metamask.io/) plugin) The developers can be reached on the `#openbounty` channel in the [Status slack](http://slack.status.im/). - ### Signing up -* point your browser to https://openbounty.status.im:444 and click `Login` +Process is the same for Bounty Creator and Bounty Hunter. + +* point your browser to URL of selected environment (`staging` or `testing`) and click `Login` * Authorise status-open-bounty to have read access to your public GitHub profile. -You should now see `Bounties`, `Activity`, `Repositories` and `Manage Payouts` tabs. In the upper right hand corner, there should be a dropdown with your GitHub username and options `My Payment Details` and `Sign Out`. +You should now see `Bounties`, `Activity`, `Repositories` tabs. In the upper right hand corner, there should be a dropdown with your GitHub username and options `My Payment Details` and `Sign Out`. +## For Bounty Creator ### Connecting your wallet -(instructions for Metamask) * install Metamask and configure your account * select `My Payment Details` from the top-right dropdown, select the account you want to use from the selection list and click `Update` ### Creating bounty issues -Before you can create bounties, you need to add Open Bounty GitHub App to your account or repos. Go to https://github.com/apps/status-open-bounty-app-test (or link to another GitHub App you've created for testing, as described in the [README](README.md) and click Install. Specify whether access to all org repos or specific repos is granted. This will install webhooks for SOB in your repos. +Before you can create bounties, you need to add Open Bounty GitHub App to your account or repos. Go to **GitHub app** for selected environment(or link to another GitHub App you've created for testing, as described in the [README](README.md) and click Install. Specify whether access to all org repos or specific repos is granted. This will install webhooks for SOB in your repos. * Request for your account to be whitelisted. Contact [Riot](https://chat.status.im) for more information * now, add the `bounty` label to a new or an existing issue. This should cause Status Open Bounty to post a new comment for the issue containing an image with text `Deploying contract, please wait` * once the contract has been mined, the comment will be updated to contain the bounty contract's address and a QR code +* in SOB `Manage Payouts` should appear (when you logged in) ### Funding bounties The Github comment has a QR code as an image containing the bounty contract address. The address is also on the comment as text. Use any ethereum wallet to send ETH and/or supported ERC20 tokens to this address. After a small delay (max 5 minutes), the activity feed should show that the related bounty issue's balance increased and comment should be updated. - -### Submitting claims - -To get bounties you need to provide an Ethereum address in you Payment details on the https://openbounty.status.im:444 that will be used to send bounties to. - -Open a pull request against the target repository with `Fixes: #NN` in the comment where `NN` is the issue number of the bountied Github issue. After the PR has been opened, the activity feed should show an item indicating that your username has opened a claim for the related bounty issue. The repository admin should also see the claim under `Open claims` in the `Manage payouts` view. +After this process bounty is available for BountyHunters on URL of selected environment in `Open Bounty` list. ### Managing payouts @@ -52,8 +64,20 @@ Repository admins see a listing of all open claims and bounties that have alread ### Removing bounties -To remove issue from the Bounties list you can close it in GitHub. +To remove issue from the Bounties list you can close it in GitHub. +## For Bounty Hunter + +### Submitting claims + +Whole process is explained here: [Status Open Bounty Tutorial](https://www.youtube.com/watch?v=vTjcXP4kTHc). + +To get bounties you need to provide an Ethereum address in you Payment details on the selected that will be used to send bounties to. + +Open a pull request against the target repository with any keyword from [Closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/), i. e. `Fixes: #NN` in the comment where `NN` is the issue number of the bountied Github issue. +After the PR has been opened, the `Activity` feed should show an item indicating that your username has opened a claim for the related bounty issue. The repository admin (Bounty Creator) should also see the claim under `Open claims` in the `Manage payouts` view. + +Flow walkthrough for Bounty Creator and Bounty Contributor is [here](https://docs.google.com/presentation/d/1btWVeaqR6yPLSHHZQ2XgfgK8MU2tWuAtNUE_5hdfJCI/edit#slide=id.g314ca9a4e1_0_0). ### Reporting bugs All bugs should be reported as issues in the [OpenBounty Github repository](https://github.com/status-im/open-bounty/issues).