Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Tidied a few files up and added some necessary extra documentation.

  • Loading branch information...
commit c049e1711dc2fd6c38f57e2b9d7b14c105c91573 1 parent 35861d1
@samwho authored
View
5 README.md
@@ -16,8 +16,9 @@ project to post pull requests to the mailing list and promote code review.
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.
+config.sample.inc.php - This is where all of the configuration information is
+stored. You will need to cmake a copy of this file and make all necessary
+changes to make it suit your purposes.
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
View
3  config.sample.inc.php
@@ -2,6 +2,9 @@
/*
* This config file contains all of the information required for this code
* to work. Please ensure that it is all correct.
+ *
+ * You need to copy this and name the copy "config.inc.php" to ensure that
+ * your settings get loaded and the program works.
*/
/*
View
7 templates/template_readme.txt
@@ -7,7 +7,7 @@ It is, however, pretty customisable. By default, placeholders are delimited
the square brackets and the plus symbols.
All template parsing happens in classes/class.TemplateParser.php. In this class
-you can change the delimiters and you can change the tokens.
+you can change the delimiters and you can change the tokens (if you want to).
The currently available tokens are:
@@ -34,4 +34,7 @@ set the 'group_requests' to false, this is the .tpl file that will be used.
'pull_request_group.tpl' - If you set the 'group_requests' value to true in the
config file, this .tpl is used FOR EACH PULL REQUEST. It is for a SINGLE PULL
REQUEST. All pull requests will be formatted like this. Look at
-'group_request_email.tpl' for the formatting of the entire email.
+'group_request_email.tpl' for the formatting of the entire email.
+
+'pull_request_single_subject_line.tpl' - This is the email subject line for
+single pull request emails.
Please sign in to comment.
Something went wrong with that request. Please try again.