Get Started

Select your use case:

Repository Owner

Setup:

  1. Install the boss github app on the repos you'd like to use boss
  2. Recommended: install the boss README badge
  3. Optionally, if you also want to create or earn bounties: Log In with GitHub and see the sections below

See an example of boss in an issue: kistek/boss-sandbox-demo#6

For more read the repository owners documentation.

Bounty Creator

Bounties are created for any repo via the UI here (login required), or by entering text commands into github issues if the issue's repository has the boss github app installed. An installation is typically marked with a README badge: boss shield/badge

To send boss bounties you'll need:

Bounty Creation In GitHub Issue Video

Video Player is loading.
Current Time 0:00
Duration 0:13
Loaded: 0.00%
Stream Type LIVE
Remaining Time 0:13
 
1x

For an example issue see: kistek/boss-sandbox-demo#6
For more read the creating bounties documentation

Bounty Earner

Bounties are earned by closing github issues that have bounties attached. The issue's repository may or may not have the boss github app installed which is typically marked with a README badge: boss shield/badge. If the GitHub App is installed on the issue, the bounties will be transferred automatically to the bounty earner. Otherwise, the bounty earner will have to click on the bounty badge to claim the solution.

To earn boss bounties you'll need:

  • Be a legal resident or citizen of a supported country
  • A GitHub account
  • To be a person, not an organization or business. Organizations will be suppored in a future release.
  • A boss account
  • A bank account (international) or debit card (US only)
  • Personal details for financial regulations (varies by country)
  • Close an issue with boss bounty attached. You must use a github issue close keyword, e.g.
    close #930 in your commit message.

Automatic Bounty Earning Video

Video Player is loading.
Current Time 0:00
Duration 0:40
Loaded: 0.00%
Stream Type LIVE
Remaining Time 0:40
 
1x

For an example issue see: kistek/boss-sandbox-demo#11

For more read the earn bounties documentation