Skip to content

Commit ffec16e

Browse files
authored
Merge pull request #1 from githoney-io/updating-docs
docs updated with latest changes
2 parents 6f7d74e + baba801 commit ffec16e

15 files changed

+109
-61
lines changed

img/accept-bounty.png

232 KB
Loading

img/accept-cmd.png

-56.1 KB
Binary file not shown.

img/acceptBounty.png

-141 KB
Binary file not shown.

img/attach-cmd.png

-72.6 KB
Binary file not shown.

img/attachBounty.png

-112 KB
Binary file not shown.

img/create-bounty.png

350 KB
Loading

img/link-bounty.png

171 KB
Loading

img/prMerged.png

-69.1 KB
Binary file not shown.

pages/_meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"title": "For Contributors"
1313
},
1414
"accept_bounty": "Accept bounty",
15+
"link_bounty": "Link bounty",
1516
"claim_reward": "Claim reward",
1617
"-- For Sponsors --": {
1718
"type": "separator",

pages/accept_bounty.mdx

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,35 @@
11
import { Callout } from "nextra/components";
22

3-
# Claim a bounty
3+
# Accept a bounty
44

55
This guide will explain how contributors can accept an existing bounty by
66
creating a Github PR that references it.
77

8-
## Start a pull-request
8+
## Find a bounty
99

10-
The process starts by creating a new PR. This PR can be from a branch in the
11-
original repository or from a fork.
12-
13-
It's recommended to start as a draft PR to make it explicit that the task hasn't
14-
been finished. It doesn't have to contain any code at this point, it can be just
15-
an empty branch.
10+
The process starts finding an issue with a bounty. The maintainer should have
11+
made the initial deposit into the bounty and no one should have accepted the bounty previously.
1612

1713
## Accept the bounty
1814

19-
Once you've created a PR, link it to the bounty you want to claim.
15+
Once you've found an issue, accept it!
2016

21-
You can do this by adding a comment in the PR that starts with
17+
You can do this by adding a comment in the issue that starts with
2218
`/githoney` and calls the `accept-bounty` command.
2319

2420
Since only one contributor can be assigned to a bounty, it's crucial to do this early! This avoids the disappointment of putting in effort only to find someone else has already claimed the reward.
2521

2622
The `accept-bounty` command has the following parameters:
2723

2824
- `bountyId`: the id of the contract of the bounty, which can be found as a
29-
comment in by the bot in the issue that describes the task.
25+
comment by the bot in the issue that describes the task.
3026
- `address`: the Cardano wallet address that will be used to claim the reward if
3127
/ when the PR get approved and merged.
3228

3329
**Example:**
3430

3531
```
36-
/githoney accept-bounty --bountyId abc111 --address addr1xxx
32+
/githoney accept-bounty --bountyId 111 --address addr1*
3733
```
3834

3935
<Callout type="info">

0 commit comments

Comments
 (0)