Skip to content

README.md

Latest commit

 

History

History
65 lines (46 loc) · 1.97 KB

README.md

File metadata and controls

65 lines (46 loc) · 1.97 KB

Bot

Prerequisites

Install

git clone https://github.com/linksplatform/Bot
cd Bot/csharp/Bot
dotnet restore

Prepare

For the bot to work, you need to get a token. You can do this here: https://github.com/settings/tokens/new.

Synopsis

dotnet run NICKNAME TOKEN APP_NAME [LINKS_DB] [FILE_SET_NAME] [MINIMUM_INTERACTION_INTERVAL]

Parameters

  1. NICKNAME - A username.
  2. TOKEN - A GitHub access token.
  3. A name of your GitHub App.
  4. Path to a database file. Default: db.links
  5. File set name. Default: HelloWorldSet.

Example

dotnet run MyNickname ghp_123 MyAppName db.links HelloWorldSet

Quick run by using sh script run.sh:

./run.sh NICKNAME TOKEN APP_NAME

Features

The bot responds to GitHub issues with specific triggers:

  • Hello World: Create issues with title "hello world" to test the bot
  • Organization Last Month Activity: Create issues with title "organization last month activity" to get member activity
  • Top by Technology: Create issues with title "Top by technology [TECHNOLOGY_NAME]" to get users ranked by their activity with specific technologies

Top by Technology

The "Top by technology" feature analyzes repositories in your organization and ranks users based on:

  • Commit activity in repositories that contain the specified technology
  • Overall contribution activity weighted by technology usage
  • Repository language analysis and file patterns

Example usage:

  • "Top by technology CUDA" - Find users working with CUDA
  • "Top by technology Qt" - Find users working with Qt
  • "Top by technology Docker" - Find users working with Docker
  • "Top by technology React" - Find users working with React

The bot will analyze the last 3 months of activity and return the top 10 contributors for the specified technology.