Bounty Hunter Documentation
Introduction
Welcome to BountyHub! This documentation is designed to help you navigate the process of claiming bounties by submitting pull requests. Follow these guidelines to ensure a smooth experience.
Table of Contents
- 1: Getting Started
- 2: Submitting a Pull Request
- 3: Claiming a Bounty
- 4: Dispute Process
- 5: FAQs
- 6: Support
Getting Started
Account Creation
- Visit the BountyHub homepage.
- Click on the "Sign In" button.
- Sign up using your GitHub account.
Finding a Bounty
Browse Bounties
- Visit the BountyHub homepage.
- Use the search bar to find bounties that match your interests. orApply filters to narrow down the results based on language,or reward amount.
- Click on a bounty to view more details, including the issue description, reward amount, and deadline.
Submitting a Pull Request
Prerequisites
The github account that submits the pull request must be the same used (to login) in bountyhub to claims the bounty
Work on the Issue
- Fork the Repository
- Fork he GitHub repository associated with the bounty issue.
- Clone the repository to your local machine.
- Implement the Solution
- Work on the issue as described in the bounty details.
- Ensure your code adheres to the project's coding standards and guidelines.
- Create a Pull Request
- Once your solution is ready, push your changes to your fork.
- Open a pull request (PR) from your fork to the original repository.
Claiming a Bounty
Submit Your Claim
- Submit Pull Request URL
- Find the bounty you worked on.
- Click "Submit Claim" and provide the URL of your pull request.
- Wait for Merge
- Your pull request needs to be merged before you can claim the bounty.
- Keep an eye on the PR status and address any feedback from the repository maintainers.
Approval Process
- Email Notification
- Once your claim is refreshed, an email will be sent to the bounty creator.
- The bounty creator has 7 days to accept or reject your claim.
- Acceptance
- If accepted, you will receive the bounty reward and it will be added to your balance
- Rejection
- If rejected, you will receive an email with the rejection reason.
Dispute Process
Filing a Dispute
- Navigate to My Bounties
- Go to the "My Bounties" page from the Dashbaord.
- Create Dispute
- Find the rejected claim.
- Click "Open Dispute" and provide details supporting why your PR resolves the issue.
Manual Verification
- Review by BountyHub Team
- The BountyHub team will manually review your dispute and the pull request.
- Decision
- You will be notified via email about the decision.
- If the dispute is resolved in your favor, you will receive the bounty reward.
FAQs
How long does the bounty approval process take?
- The bounty creator has 7 days to review and accept or reject your claim.
What if my pull request is not merged
- Contact the bounty creator through the issue comments on GitHub to address any concerns. If the PR remains unmerged, the bounty cannot be claimed.
Can I work on multiple bounties at the same time?
- yes, you can work on and submit claims for multiple bounties simultaneously.
Support
If you have any questions or encounter issues, please contact our support team:
Email: [email protected]
131 Continental Dr, Suite 305 Newark, DE 19713
By following this documentation, you should be well-equipped to claim bounties on BountyHub successfully. Happy coding!