summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/contributing
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide_src/source/contributing')
-rw-r--r--user_guide_src/source/contributing/index.rst27
1 files changed, 17 insertions, 10 deletions
diff --git a/user_guide_src/source/contributing/index.rst b/user_guide_src/source/contributing/index.rst
index c784a59e5..e88147753 100644
--- a/user_guide_src/source/contributing/index.rst
+++ b/user_guide_src/source/contributing/index.rst
@@ -2,6 +2,12 @@
Contributing to CodeIgniter
###########################
+.. toctree::
+ :titlesonly:
+
+ ../documentation/index
+ ../DCO
+
CodeIgniter is a community driven project and accepts contributions of code
and documentation from the community. These contributions are made in the form
of Issues or `Pull Requests <http://help.github.com/send-pull-requests/>`_ on
@@ -28,12 +34,12 @@ Note that GitHub is not for general support questions!
If you are having trouble using a feature of CodeIgniter, ask for help on the forum.
-If you are wondering if you are using
+If you are wondering if you are using
something correctly or if you have found a bug, ask on the forum first.
-***************************
+****************************
Tips for a Good Issue Report
-***************************
+****************************
Use a descriptive subject line (eg parser library chokes on commas) rather than a vague one (eg. your code broke).
@@ -86,9 +92,10 @@ must also be updated for every change. Also PHPDoc blocks must be maintained.
Compatibility
=============
-CodeIgniter is compatible with PHP 5.2.4 so all code supplied must stick to
-this requirement. If PHP 5.3 or 5.4 functions or features are used then there
-must be a fallback for PHP 5.2.4.
+CodeIgniter recommends PHP 5.4 or newer to be used, but it should be
+compatible with PHP 5.2.4 so all code supplied must stick to this
+requirement. If PHP 5.3 (and above) functions or features are used then
+there must be a fallback for PHP 5.2.4.
Branching
=========
@@ -132,10 +139,10 @@ This will sign your commits with the information setup in your git config, e.g.
Signed-off-by: John Q Public <john.public@example.com>
-If you are using Tower there is a "Sign-Off" checkbox in the commit window. You
-could even alias git commit to use the -s flag so you don’t have to think about
+If you are using Tower there is a "Sign-Off" checkbox in the commit window. You
+could even alias git commit to use the -s flag so you don’t have to think about
it.
-By signing your work in this manner, you certify to a "Developer's Certificate
+By signing your work in this manner, you certify to a "Developer's Certificate
or Origin". The current version of this certificate is in the :doc:`/DCO` file
-in the root of this documentation. \ No newline at end of file
+in the root of this documentation.