Skip to content
This repository has been archived by the owner on Oct 17, 2018. It is now read-only.

Latest commit

 

History

History
41 lines (29 loc) · 1.67 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.67 KB

WordPress IRC Contributors

The WP IRC Contributors project is an IRC bot intended to automatically identify (and eventually credit) users who contribute to the WordPress project by providing support and guidance over IRC. Much like the forums, which are somewhat easier to track users engagement, the IRC channel lacks such an identifying factor, which this project looks to remedy.

Currently there are multiple metrics being recorded to try and identify which one (or combination of ones) that best serves our purpose to keep things fair, but at the same time avoid people gaming the system for internet points.

Dependencies

The bot is ran on PHP, both to keep it portable, but also because the WordPress project already runs a few resources this way and by utilizing the same libraries we ensure that the project doesn't stop if something happens to a single person.

  • PHP
  • MySQL - We use MariaDB as a drop-in replacement
  • SmartIRC - A PHP library for interacting with IRC

Install & Run

git clone https://github.com/Clorith/WP-IRC-Contributors WP-IRC-Contributors
cd WP-IRC-Contributors/IRC
php contributor-bot.php

General configurations are done in config.php Remember to import the content from database\database.sql to properly set up your SQL.

To-do

What needs to be done

  • Are we logging what we need to get the metrics for a baseline contributor
  • Find a reliable formula to use the contributions, see C-level from the web interface

License

We use the GPLv2 license which allows anyone to play around with our code in any way they like, have fun!