note that 3.0.14 wasn't released in March...

[freeradius.git] / CONTRIBUTING

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 90654d4..7deb291 100644 (file)
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -9,8 +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 your issue will likely be closed with a link to this document,
-  and locked.
+  If you choose to ignore these guidelines our response will be a link to this document.
 
 
 1.GITHUB ISSUE TRACKER
@@ -38,7 +37,7 @@
   to reproduce your issue.
 
   The ChangeLog (https://github.com/FreeRADIUS/freeradius-server/blob/v3.0.x/doc/ChangeLog) for the
-  active branch may also be used to determine if your issue has already been addressed.
+  current stable branch may also be used to determine if your issue has already been addressed.
   The ChangeLog is updated as fixes are made to the server code, and usually reflects the state of the
   Git HEAD.
 
@@ -51,12 +50,17 @@
   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
 
   If you're developing a new feature, module, or writing large amounts of code to fix a defect, contact
   a member of the FreeRADIUS development team first.  For simpler one or two line fixes, go ahead and
-  open a pull-request immediately, the worst that'll happen is that we'll fix it in a different way.
+  open a pull-request immediately.
 
   The dev team can be contacted via the devel mailing list (http://freeradius.org/list/devel.html),
   or via GitHub by using the GitHub issue tracker.
@@ -69,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
 
@@ -77,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