Snag Docs logo

Fork a GitHub Repository

GitHub repo fork loyalty rule. Reward users for forking your GitHub repository.

Overview

This loyalty rule allows admins to reward users for forking a specific GitHub repository. This rule is useful for encouraging developers to contribute to your open-source projects and build community engagement.

Snag admin fork a GitHub repository rule configuration form

Prerequisites

  • The user must have connected their GitHub account to Snag.
  • The user must fork 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 Fork GitHub Repository rule rewards users immediately upon successful verification that the repository has been forked.
  • User Reward Frequency: This is a one-time reward that users can claim after forking 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 fork (e.g., https://github.com/owner/repository). This is a required field that identifies the target repository.

Verification Process

Users verify their GitHub repository fork 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
Fork the GitHub repository

Users navigate to the specified GitHub repository using the provided URL and click the fork button to create a fork of the repository.

3
Claim the reward

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

4
System verification

The system verifies that: - The repository has been forked by the user's connected GitHub account - The fork is a direct fork of the specified repository

5
Reward distribution

Once verified, users receive their reward immediately.

Important Notes

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