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.rst42
1 files changed, 39 insertions, 3 deletions
diff --git a/user_guide_src/source/contributing/index.rst b/user_guide_src/source/contributing/index.rst
index 4d3fe6ede..c784a59e5 100644
--- a/user_guide_src/source/contributing/index.rst
+++ b/user_guide_src/source/contributing/index.rst
@@ -5,8 +5,8 @@ Contributing to CodeIgniter
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
-the `EllisLab CodeIgniter repository
-<https://github.com/EllisLab/CodeIgniter>`_ on GitHub.
+the `CodeIgniter repository
+<https://github.com/bcit-ci/CodeIgniter>`_ on GitHub.
Issues are a quick way to point out a bug. If you find a bug or documentation
error in CodeIgniter then please check a few things first:
@@ -20,6 +20,42 @@ Reporting issues is helpful but an even better approach is to send a Pull
Request, which is done by "Forking" the main repository and committing to your
own copy. This will require you to use the version control system called Git.
+*******
+Support
+*******
+
+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
+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).
+
+Address a single issue in a report.
+
+Identify the CodeIgniter version (eg 3.0-develop) and the component if you know it (eg. parser library)
+
+Explain what you expected to happen, and what did happen.
+Include error messages and stacktrace, if any.
+
+Include short code segments if they help to explain.
+Use a pastebin or dropbox facility to include longer segments of code or screenshots - do not include them in the issue report itself.
+This means setting a reasonable expiry for those, until the issue is resolved or closed.
+
+If you know how to fix the issue, you can do so in your own fork & branch, and submit a pull request.
+The issue report information above should be part of that.
+
+If your issue report can describe the steps to reproduce the problem, that is great.
+If you can include a unit test that reproduces the problem, that is even better, as it gives whoever is fixing
+it a clearer target!
+
+
**********
Guidelines
**********
@@ -33,7 +69,7 @@ PHP Style
=========
All code must meet the `Style Guide
-<http://ellislab.com/codeigniter/user-guide/general/styleguide.html>`_, which is
+<http://codeigniter.com/user_guide/general/styleguide.html>`_, which is
essentially the `Allman indent style
<http://en.wikipedia.org/wiki/Indent_style#Allman_style>`_, underscores and
readable operators. This makes certain that all code is the same format as the