recursive recursion is bad

[freeradius.git] / CONTRIBUTING

diff --git a/CONTRIBUTING b/CONTRIBUTING
index ac3bef3..7deb291 100644 (file)
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -9,7 +9,7 @@
   via GitHub.  If you follow these guidelines, it is very likely that your question, bug report or pull
   request will be acted on, and in a timely manor.
 
-  If you choose to ignore these guidelines the response will be a link to this document.
+  If you choose to ignore these guidelines our response will be a link to this document.
 
 
 1.GITHUB ISSUE TRACKER
@@ -50,6 +50,11 @@
   See doc/bugs (https://github.com/FreeRADIUS/freeradius-server/blob/master/doc/bugs) for information
   on what to include, and how to obtain it.
 
+  When logging bug reports using the GitHub issue tracker, pay attention to formatting.  You should
+  ensure any log output is surrounded by two sets of tripple backticks (```).  If you don't do this
+  Github will automatically link your issue to other pre-existing issues when it encounters a #<num>
+  string.
+
 
 4.PULL REQUESTS AND CODING STANDARDS
 
@@ -68,7 +73,11 @@
 
     http://wiki.freeradius.org/contributing/coding-standards
 
-  ...and start writing code.  You may also wish to utilise the doxygen site:
+  If you're creating a new module you may wish to read the module creation guide:
+
+    http://wiki.freeradius.org/contributing/Modules3
+
+  You may also wish to utilise the doxygen site to review code documentation:
 
     http://doc.freeradius.org
 
@@ -76,6 +85,12 @@
   as structs, and callback declarations.  doc.freeradius.org is updated within one minute of each commit
   to the master branch of the main freeradius-server repo.
 
+  Finally, this file was written to be displayed automatically on the GitHub issue tracker, so
+  Git/GitHub knowledge is assumed.  If you're wondering what the heck a pull-request is, this
+  document may be of some use:
+
+    http://wiki.freeradius.org/contributing/GitHub
+
 
 5.CONTINUOUS INTEGRATION TESTS