Polar synchronizes all of your issues during onboarding & keeps them up-to-date in near real-time (thanks to GitHub webhooks).
Combined with offering some powerful additions such as...
Progress overview
Sort by community impact
... and of course the ability to seamlessly embed & manage the Polar Badge, funding & contributor rewards across them.
In case you did not opt-in to badge all issues automatically in your settings you can easily do so manually. You can either:
Label the issue on GitHub directly using the label Fund
(case insensitive)
Click Add badge
for the desired issue in your Polar dashboard
This will automatically open the customiztion modal below.
Almost instantly the Polar Badge is embedded at the end of the GitHub issue description by the Polar GitHub App you've installed 🎉
The issue will be marked as badged within your Polar dashboard too.
You can customize funding & badge settings for individual issues to override
your default
settings. Just click the
Badged
button next to the desired issue on the Issues
page within Polar.
This opens up the customization modal. Let's go through each tab below.
You can easily tweak or even completely change the default description you setup during onboarding for a specific issue.
Edit
to enable editingUpdate
to save your changesDisplays a specific goal to backers combined with a progressbar towards it within the badge.
Update
to save your changes"GitHub caches the badge for ~30-90 seconds"
We set no-cache
headers and GitHub does support this. However, their proxy CDN
seems to have a minimal Cache TTL nonetheless, but it's very short-lived
(with no headers it's cached for much longer).
Want to setup contributor rewards upfront & promote it publically (optional)? Awesome, let's do it - it's incredibly easy.
Switch the Public rewards
toggle to on (highlighted in blue)
Customize the split in percentage you want to allocate to contributor(s) vs. yourself
Default is 50/50, but you can offer contributors anything from 1% to 100%. Did you end up doing everything yourself? Don't worry, you can adjust this once the issue is completed before payouts.
You're done. Changes are saved automatically.
Have some prior funding you want to offer yourself to contributors? You can easily make your own pledge in the modal (invoice sent once issue is completed).
Pledge
Promoting the ability to fund an issue to your community is a great way to drive more funding towards it.
You can post a new comment on the GitHub issue directly from within this view and the badge will be embedded at the end of the comment.
This has a couple of benefits:
In case you submit a comment via the modal (optional), it will be posted on
your behalf. This is mentioned next to the Post
action so it's never a
surprise. Additionally, GitHub will add the Polar logo in connection with
your avatar for the comment - indicating it was done via the Polar App.
Copy
to copy the direct link to the issues funding pageThe Polar Badge is an SVG (dark & light mode) that you can bring elsewhere too.
Copy
to copy the SVG embed code
Polar is deeply integrated with GitHub and your usual workflow. Draft, merged or active PRs and commits referencing your issues are automatically detected and showcased upfront. Updated in near real-time.
So you can focus on making progress with contributors vs. tracking it.
Once an issue is closed - in case it has received funding - we'll prompt you via email and in our dashboard to mark it as completed. We require this manual step to avoid triggering the actions below prematurely or by mistake.
The modal above will appear once you've marked an issue as completed. Polar will automatically suggest contributors from merged PRs referencing the issue. Making it super simple to share funding with them.
Once you're done and click Confirm
you can easily share the great news with
the contributors in the form of a GitHub comment. You can edit the suggested
comment freely. Just make sure to keep the username pings & instructions 🙂
Great. You've setup funding, received it from your community towards a few issues & hacked away to complete one of them. Now what?
Once an issue is closed, you'll be prompted by Polar to mark it as completes. Backers will then receive an email notification about it and have 7 days to either:
Polar then reviews and approves transfers from our platform account to your balance on Polar. In case of disputes, we review it to make a fair decision.
Once completed, the funds will be available on your Polar balance and you can manually withdraw it at anytime.
Read more about how to see & manage your Balance & Payouts.