# Claim Reward Criteria & Troubleshooting Guide

## Claim Reward Criteria

To successfully claim a reward for a bounty, follow these steps:

### 1. **Register and Log In with GitHub**

{% hint style="warning" %}

#### :warning: VERY Important :warning:

It’s essential to register and log in to Lightning Bounties using your GitHub account **before** submitting your PR and clicking ***"Claim Reward."***

* This ensures your reward is properly linked to your account and that you’re eligible to claim the bounty.
  * *See* [first-time-onboarding](https://docs.lightningbounties.com/docs/getting-started/first-time-onboarding "mention") *For Detailed Instructions.*
    {% endhint %}

### 2. Find an Issue

* Browse available bounties on the [app.lightningbounties.com](http://app.lightningbounties.com/) feed
* Review the issue details, requirements, and reward amount
* Check if the bounty is still available (not claimed by someone else)
  * *See* [looking-for-a-project-to-get-rewarded](https://docs.lightningbounties.com/docs/getting-started/solving-a-bounty/looking-for-a-project-to-get-rewarded "mention") *For Detailed Instructions.*

### 3. Fix the Issue

* Fork the repository to your GitHub account
* Clone your fork locally and create a branch for your work
* Implement the fix according to the issue requirements
* Test your changes thoroughly to ensure they meet all acceptance criteria
* Push your changes to your fork
  * *See* [working-on-the-bounty](https://docs.lightningbounties.com/docs/getting-started/solving-a-bounty/working-on-the-bounty "mention") *For Detailed Instructions.*

### 4. Create a Pull Request (PR) **Targeting Main/Master**

* Go to the original repository on GitHub.
* Click "Compare & pull request" for your branch.

{% hint style="warning" %}
:warning: **CRITICAL STEP** :warning:

In the PR description, include `close #issue-number` or `closes #issue-number` to link the PR to the issue.
{% endhint %}

> ### :information\_source: **Why?**
>
> <mark style="background-color:orange;">GitHub only recognizes linked issues when the PR targets the repository's default branch (usually main or master).</mark>
>
> * [Learn more about linking PRs to issues.](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)

* Provide a clear explanation of your changes and how they address the issue.
* You can include as much additional information as needed in your PR description.
* Submit the PR for review

#### PR Requirements Checklist

Before you request review, verify all items below:

* PR targets the repo default branch (`main` or `master`)
* PR body includes `close #issue-number` or `closes #issue-number`
* PR body references the Lightning Bounties issue URL
* PR contains real code/docs changes (not an empty PR)
* PR passes repository checks (CI/tests/lint if required by that repo)
* PR is not in draft state
* PR uses the same GitHub account connected to your Lightning Bounties account
* PR stays focused on the bounty scope and acceptance criteria

{% hint style="info" %}
Tip: If maintainers require a specific template, fill every required section in the PR form so review is not blocked.
{% endhint %}

**Screenshot Example:**

<figure><img src="https://4191743023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgvH1HLwrajw9XplSBFfy%2Fuploads%2Fldl29BZP2Haz8bnq3wdu%2FmergedPRScreenShot_ChangeIttoGreenOpenCheckmark.png?alt=media&#x26;token=4236d9a6-493e-4d62-a373-53f725843256" alt="Example: PR description with correct close syntax and branch targeting."><figcaption><p>Example: PR description with correct close syntax and branch targeting.</p></figcaption></figure>

{% hint style="info" %}
:information\_source: **INFO** :information\_source:

***You may need to refresh the GitHub page to see the issue show up as linked.***
{% endhint %}

### 5. **Wait for Maintainer to Merge the PR**

* The repository maintainer will review your PR.
  * Once it is approved and merged, the issue will be closed automatically if you used the correct `close`syntax.
    * *See* [working-on-the-bounty](https://docs.lightningbounties.com/docs/getting-started/solving-a-bounty/working-on-the-bounty "mention") *For Detailed Instructions.*

### 6. Claim Reward Process

* **Manually claim your reward:**
  * Visit [app.lightningbounties.com](http://app.lightningbounties.com/) and find the Bounty you solved
  * Click the "***Claim Reward***" button
  * Click the "***Check***" button to verify your eligibility

{% hint style="warning" %}
:warning:**IMPORTANT**:warning:

The reward process will not start automatically.

You must manually complete the claim steps on [app.lightningbounties.com](http://app.lightningbounties.com/) after your PR is merged.
{% endhint %}

<figure><img src="https://4191743023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgvH1HLwrajw9XplSBFfy%2Fuploads%2Fp5BSDpDDNH4tHjMFTNbh%2Fcheck_claim_reward.JPG?alt=media&#x26;token=b28f8d8e-75d1-478e-be98-0dd40fd19392" alt="Claim Reward &#x26; Check Interface on Lightning Bounties"><figcaption><p>Claim Reward &#x26; Check Interface on <a href="https://app.lightningbounties.com/">app.lightningbounties.com</a></p></figcaption></figure>

{% hint style="success" %}

#### :checkered\_flag:Complete :checkered\_flag:

**Once your PR is merged and your eligibility is verified, the reward will be deposited directly into your Lightning Bounties balance.**
{% endhint %}

***

### Complete Claim Process Visualization

{% tabs %}
{% tab title="Complete Claim Process" %}

<div data-full-width="false"><figure><img src="https://4191743023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgvH1HLwrajw9XplSBFfy%2Fuploads%2FNAjnwq6qZ82bJdH9v2ie%2FComplete_Claim_Process_Updated.png?alt=media&#x26;token=8294dfdb-bfb8-46d5-9a4e-755f8a68450c" alt="Complete Claim Process"><figcaption><p>Complete Claim Process</p></figcaption></figure></div>
{% endtab %}

{% tab title="Simplified Workflow" %}

<figure><img src="https://4191743023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgvH1HLwrajw9XplSBFfy%2Fuploads%2FWu4OzOeGEbAHJGrimCLh%2Fvisualworkflow.JPG?alt=media&#x26;token=7799e168-51a5-4a24-be35-abc35f4be6a5" alt="Simplified Workflow"><figcaption><p>Simplified Workflow</p></figcaption></figure>
{% endtab %}
{% endtabs %}

***

## Troubleshooting

If you encounter issues claiming your Lightning Bounty reward, use this guide to diagnose and resolve common problems.

For more details, see the [Lightning Bounties Troubleshooting Guide](https://docs.lightningbounties.com/docs/getting-started/solving-a-bounty/claim-reward-criteria-and-troubleshooting-guide) and [GitHub’s official documentation on linking pull requests to issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).

### Quick Checklist: Claim Reward Not Working

Run this quick check in order before requesting support:

1. Confirm PR is merged into `main`/`master` (not just approved).
2. Confirm PR body includes `close #issue-number` with the correct issue number.
3. Confirm the GitHub issue is now closed.
4. Confirm you clicked **Claim Reward** and then **Check** in the app.
5. Refresh the page and re-run **Check** after a short delay.
6. Confirm you are logged into Lightning Bounties with the same GitHub identity used for the PR.
7. If still blocked, post the issue + PR links in Discord and request an override.

***

### Issue Not Linked to PR

<div data-full-width="false"><figure><img src="https://4191743023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgvH1HLwrajw9XplSBFfy%2Fuploads%2F5Erw2yhR3SnC69hMTNDh%2Fno_close_pr.JPG?alt=media&#x26;token=4612ded8-9fff-4c80-8168-a0bada90ff79" alt="Example: PR without the required &#x22;close #issue-number&#x22; syntax"><figcaption><p><em>Example: PR without the required "close #issue-number" syntax</em></p></figcaption></figure></div>

**Problem Indicators:**

* The PR does not show the linked issue in the GitHub interface.
* The issue remains open after your PR is merged.
* The reward does not process automatically.

## **Solutions:**

### **1. Edit PR Description**

If your PR is still open, you can update the PR description to add the correct closing keyword (e.g., `close #issue-number`).

* Navigate to your pull request on GitHub.
* Near the top of the PR page, locate the description section (below the title).
* Hover over the description area and click the "Edit" (... or pencil) icon.
* Add the `close #issue-number`keyword at the **top of the PR description** *(not in a comment or commit message, as only the PR body triggers the automation for Lightning Bounties and GitHub)*.

{% embed url="<https://app.tango.us/app/workflow/Add-and-update-Close-Keyword-on-open-GitHub-Pull-Request-b07c259289b04ea7bc75613574f7579c>" %}
What the Workflow Looks Like
{% endembed %}

### **2. Ask Repository Owner (If you can't edit the PR)**

* Contact the repository owner or maintainer
* Ask them to edit the PR description to add the closing keyword

### **3. Create a Follow-up PR** (If original PR was already merged)

If your original PR has already been merged without the correct closing keyword: [(see below)](#example-of-a-follow-up-pr-created-to-properly-link-the-issue-for-lightning-bounty-payment)

* Create a new PR with a minimal change (e.g., update documentation, add a comment, or fix a typo).
* In the PR description, include the appropriate closing keyword (e.g., `close #42`).
* Reference your original PR:

  <pre class="language-markdown" data-overflow="wrap"><code class="lang-markdown">close #42  
  This PR references the work completed in #123 (original PR).
  </code></pre>
* Notify the repository owner about this follow-up PR and explain its purpose.
* Once merged, return to Lightning Bounties and click "Claim Reward" and "Check."

#### Example of a follow-up PR created to properly link the issue for Lightning Bounty payment :arrow\_down\_small:

<figure><img src="https://4191743023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgvH1HLwrajw9XplSBFfy%2Fuploads%2F7mB2qkXn79bJxiTgjz4z%2Ffullowup_pr_issue.JPG?alt=media&#x26;token=665994f7-d436-43e8-b57c-2dfc30feb9b3" alt=""><figcaption><p><em>Example: A minimal follow-up PR correctly referencing both the issue and original PR</em></p></figcaption></figure>

### **4. Request an Override via Discord**

If you are unable to resolve the issue through the above steps, join the [Lightning Bounties Discord](https://discord.gg/zBxj4x4Cbq) and request an override from the LB team.

* Add a comment to the PR, tagging the maintainer (e.g., `@maintainer`) and include the Lightning Bounties issue URL.
* Ask the maintainer to respond in the PR thread confirming that the PR qualifies for the bounty.

{% hint style="warning" %}

### :warning:Important :warning:

The maintainer must write a clear comment confirming the qualification (an emoji or reaction is not sufficient as proof).
{% endhint %}

For more details on linking PRs to issues, see [GitHub’s guide on linking pull requests to issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue-using-a-keyword).

#### Payment Not Received

**Verification Steps:**

1. Confirm the issue is marked as "closed" on GitHub
2. Verify the PR that closed it has been merged
3. Check that you clicked "Claim Reward" on Lightning Bounties

**Solutions:**

* **Check User Balance**: Ensure your account balance is updated on [app.lightningbounties.com](http://app.lightningbounties.com/)
* **Verify Wallet Setup**: Make sure your Lightning Network wallet is correctly configured
* **Contact Support**: If issues persist, reach out to the Lightning Bounties [Discord](https://discord.gg/zBxj4x4Cbq) for assistance

#### Common Errors and Solutions

| Error                 | Description                              | Solution                                      |
| --------------------- | ---------------------------------------- | --------------------------------------------- |
| Missing link syntax   | PR doesn't include `close #issue-number` | Edit PR description or create follow-up PR    |
| Wrong issue number    | PR references incorrect issue            | Edit PR or create new PR with correct number  |
| Not claiming reward   | Forgot to click "Claim Reward" button    | Go to Lightning Bounties app and click button |
| Issue already claimed | Another dev claimed the bounty first     | Check issue status before working on it       |

### Best Practices

* **Always double-check** the issue number when adding `close #issue-number` syntax
* **Communicate clearly** with repository maintainers about your bounty claim
* **Keep PRs focused** on addressing the specific issue
* **Don't forget** to manually click "Claim Reward" on Lightning Bounties platform

***

{% hint style="info" %}

### :information\_source: Remember :information\_source:

The Lightning Bounties system requires both proper GitHub issue linking through the `close #issue-number` syntax **AND** manual claiming through the Lightning Bounties platform.

*Both steps are essential for successful reward processing*
{% endhint %}

For additional assistance, join the Lightning Bounties [Discord](https://discord.gg/zBxj4x4Cbq) community.