Skip to content

Commit

Permalink
Better Issue report writeup
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
jim-parry committed Nov 11, 2014
1 parent 60516ab commit 9442ac4
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions user_guide_src/source/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
**********
Expand Down

0 comments on commit 9442ac4

Please sign in to comment.