Holopin GitHub bot

A Holopin integration for GitHub, allowing Holopin organizations to easily reward your community members directly in Issue, PR and Discussion conversations.

Example use cases:

• Rewarding contributors
• Recognizing community helpers
• Welcoming new members
• Encouraging good practices, eg. rewarding those who provide comprehensive bug reports, error stack traces, fully scoped out feature suggestions

Getting started

Prerequisites

Repo maintainer(s) need to members of the Holopin organization whose stickers they are issuing.

Issuers should also have their personal Holopin accounts linked with GitHub. You can manage your Third party connections in your Account settings:

Installation

1. Install the Holopin App on your repository (choose "select repositories" in the options)
2. Create a .github/holopin.yml config file in the repo

Configuration

Create a .github/holopin.yml file that looks a little like:

organization: # org name on holopin
defaultSticker: # sticker ID
stickers:
  -
    id: # sticker id
    alias: # shorthand-string
  -
   id:
   alias: 

Usage

Method 1: Tagging the bot in conversation

Issuing badges

Once you have the app configured on your repository, you can issue badges to a contributor by tagging @holopin-bot and the recipient's GitHub @username in an Issue or a PR thread.

Issue the default badge:

Thank you for your help (...)! @holopin-bot @username

Or by alias:

Thank you for your help (...)! @holopin-bot @username sticker-alias

Claiming

Holopin bot will respond directly in the issue with a unique claim URL reserved for that specific GitHub user:

Congratulations @username, you just earned a badge! Here it is: holopin.io/claim/dfgyhjk
This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: holopin.io/account.
Or if you’re new to Holopin, you can simply sign up with GitHub, which will do the trick!

Method 2: Issue labels (Beta)

Works exactly the same as Method 1, but instead of tagging, the holopin-bot is called out upon labelling the issue with the label that corresponds to a sticker alias specified in your holopin.yaml. The recipient will be the user who created the issue.

Support

If you have any questions, feel free to ask us over at [email protected]