From 60516ab8c6838fa4da8eb7eabb5fe782c7a81c86 Mon Sep 17 00:00:00 2001 From: James L Parry Date: Mon, 10 Nov 2014 22:33:52 -0800 Subject: Fix documentation instructions Corrected the sphinx installation instructions to match the instructions in user_guide_src/README.rst Signed-off-by:James L Parry --- user_guide_src/source/documentation/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst index b080c0efa..38124f7f2 100644 --- a/user_guide_src/source/documentation/index.rst +++ b/user_guide_src/source/documentation/index.rst @@ -42,7 +42,7 @@ Pygments, so that code blocks can be properly highlighted. .. code-block:: bash - easy_install sphinx + easy_install "sphinx==1.2.3" easy_install sphinxcontrib-phpdomain Then follow the directions in the README file in the :samp:`cilexer` folder -- cgit v1.2.3-24-g4f1b From 9442ac4ae95bda1959f4cf2e88f29dc25f7b7008 Mon Sep 17 00:00:00 2001 From: James L Parry Date: Mon, 10 Nov 2014 22:53:16 -0800 Subject: Better Issue report writeup Documentation: contributing to CodeIgniter... Added a reminder about issues vs support, and some tips for a good issue report. This was suggested by a user on the forum, and seems like a good idea. Signed-off-by:James L Parry --- user_guide_src/source/contributing/index.rst | 36 ++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/contributing/index.rst b/user_guide_src/source/contributing/index.rst index 7359e09aa..c784a59e5 100644 --- a/user_guide_src/source/contributing/index.rst +++ b/user_guide_src/source/contributing/index.rst @@ -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 ********** -- cgit v1.2.3-24-g4f1b