Snag Docs logo

Star a GitHub Repository

GitHub repo star loyalty rule. Reward users for starring your GitHub repository.

Overview

This loyalty rule allows admins to reward users for starring a specific GitHub repository. This rule is useful for increasing repository visibility and building community engagement around your open-source projects.

Snag admin star a GitHub repository rule configuration form

Prerequisites

  • The user must have connected their GitHub account to Snag.
  • The user must star the specified GitHub repository.

Rule Configuration Fields

Reward

  • Type of Reward: Choose between "Points" or "Multiplier".

  • Points: Users will get the defined no of points.

  • Multiplier: Users will get the multiplier of the defined amount.

Basic Settings

  • Update Cadence: The Star GitHub Repository rule rewards users immediately upon successful verification that the repository has been starred.
  • User Reward Frequency: This is a one-time reward that users can claim after starring the repository.

Custom Settings

  • Skip the multiplier for this rule: Toggle to skip the multiplier for this rule
  • GitHub Repo URL *: The full URL of the GitHub repository that users need to star (e.g., https://github.com/owner/repository). This is a required field that identifies the target repository.

Verification Process

Users verify their GitHub repository star through the following process:

1
Connect GitHub account

Users must first connect their GitHub account to Snag if they haven't already done so.

2
Star the GitHub repository

Users navigate to the specified GitHub repository using the provided URL and click the star button to star the repository.

3
Claim the reward

After starring the repository, users can claim the reward through the loyalty rule interface.

4
System verification

The system verifies that: - The user's GitHub account has access to the repository - The repository has been starred by the user's connected GitHub account - The repository URL matches the configured repository

5
Reward distribution

Once verified, users receive their reward immediately.

Important Notes

Users must have their GitHub account connected before they can claim this reward. The system will automatically verify that the repository has been starred by the connected GitHub account.

The GitHub Repo URL should be in the format https://github.com/owner/repository.