> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snagsolutions.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Star a GitHub Repository

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

<head>
  <script type="application/ld+json">
    {JSON.stringify({
            "@context": "https://schema.org",
            "@type": "TechArticle",
            "headline": "Star a GitHub Repository",
            "description": "GitHub repo star loyalty rule. Reward users for starring your GitHub repository.",
            "author": {"@type": "Organization", "name": "Snag Solutions", "url": "https://www.snagsolutions.io/"},
            "publisher": {"@type": "Organization", "name": "Snag Solutions", "url": "https://www.snagsolutions.io/", "logo": {"@type": "ImageObject", "url": "https://assets.snagsolutions.io/public/docs/snag-logo-dark-no-bg.svg"}},
            "mainEntityOfPage": "https://docs.snagsolutions.io/loyalty/rules/github-repo-star"
          })}
  </script>
</head>

## **Overview**

This loyalty rule allows admins to reward users for starring a specific [GitHub](https://github.com/) repository. This rule is useful for increasing repository visibility and building community engagement around your open-source projects.

<Frame>
  ![Snag admin star a GitHub repository rule configuration form](https://assets.snagsolutions.io/public/docs/rules/github-repo-star.png)
</Frame>

## **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:

<Steps>
  <Step title="Connect GitHub account">
    Users must first connect their GitHub account to Snag if they haven't already done so.
  </Step>

  <Step title="Star the GitHub repository">
    Users navigate to the specified GitHub repository using the provided URL and
    click the star button to star the repository.
  </Step>

  <Step title="Claim the reward">
    After starring the repository, users can claim the reward through the loyalty
    rule interface.
  </Step>

  <Step title="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
  </Step>

  <Step title="Reward distribution">
    Once verified, users receive their reward immediately.
  </Step>
</Steps>

## **Important Notes**

<Warning>
  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.
</Warning>

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