Coder Social home page Coder Social logo

github-pull-request-email-bot's Introduction

Git Pull Request Email Bot

What is this?

The Git Pull Request Email Bot is a simple project that sends emails to a specified address every time a repository of your choice gets a pull request.

It works by adding the run.php file to a Cron job and running it fairly often (though it doesn't really matter how long you leave it, it remembers what pull request it emailed you about last and won't email duplicates).

It was originally written for the ThinkUp project to post pull requests to the mailing list and promote code review.

How does it work?

There are only a few files that you as a user need to worry about:

config.inc.php - This is where all of the configuration information is stored. You will need to change this file to make it suit your purpose.

run.php - This is the file you will need to attach to a Cron job. This file is where the magic happens: pull requests are crawled, the crawler filters out the ones it has already emailed you about and sends emails about for the new ones.

Template files - All of the template files are stored in the templates/ directory. These handle the presentation of the emails through a placeholder system. Details of this can be found in templates/template_readme.txt.

Can I contribute?

Uhm... yeah, sure, I don't see why not. I haven't really prepared the project for contributions just yet but if you want to browse the code and you see something you think you could improve then go for it! Fork it, branch it, pull it :)

github-pull-request-email-bot's People

Contributors

ginatrapani avatar

Watchers

James Cloos avatar Josh Stevens avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.