Startsida Utforska Hjälp
Logga in
wangsaitao
/
guotianyun-sp-yh
1
0
Fork 0
Filer Ärenden 0 Pull-förfrågningar 0 Wiki
Gren: master
Grenar Taggar
guotianyun-s...
/
user_guide
/
contributing
/
index.html

index.html 42 KB
Permalänk Historik Rå

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

  7.   <meta charset="utf-8">
    8. 

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    9. 

  9.   
    10. 

  10.   <title>Contributing to CodeIgniter &mdash; CodeIgniter 3.1.11 documentation</title>
    11. 

  11.   
    12. 

  12. 

  13.   
    14. 

  14.   
    15. 

  15.     <link rel="shortcut icon" href="../_static/ci-icon.ico"/>
    16. 

  16.   
    17. 

  17. 

  18.   
    19. 

  19.   <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
    20. 

  20. 

  21.   
    22. 

  22.   
    23. 

  23.     
    24. 

  24. 

  25.   
    26. 

  26. 

  27.   
    28. 

  28.   
    29. 

  29.     <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
    30. 

  30.   
    31. 

  31. 

  32.   
    33. 

  33.         <link rel="index" title="Index"
    34. 

  34.               href="../genindex.html"/>
    35. 

  35.         <link rel="search" title="Search" href="../search.html"/>
    36. 

  36.     <link rel="top" title="CodeIgniter 3.1.11 documentation" href="../index.html"/>
    37. 

  37.         <link rel="next" title="Writing CodeIgniter Documentation" href="../documentation/index.html"/>
    38. 

  38.         <link rel="prev" title="Conclusion" href="../tutorial/conclusion.html"/> 
    39. 

  39. 

  40.   
    41. 

  41.   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
    42. 

  42. 

  43. </head>
    44. 

  44. 

  45. <body class="wy-body-for-nav" role="document">
    46. 

  46. 

  47.   <div id="nav">
    48. 

  48.   <div id="nav_inner">
    49. 

  49.     
    50. 

  50.     
    51. 

  51.     
    52. 

  52.       <div id="pulldown-menu" class="ciNav">
    53. 

  53.         <ul>
    54. 

  54. <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
    55. 

  55. </ul>
    56. 

  56. <ul>
    57. 

  57. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    58. 

  58. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    59. 

  59. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    60. 

  60. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    61. 

  61. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    62. 

  62. </ul>
    63. 

  63. </li>
    64. 

  64. </ul>
    65. 

  65. <ul>
    66. 

  66. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    67. 

  67. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    68. 

  68. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    69. 

  69. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    70. 

  70. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    71. 

  71. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    72. 

  72. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    73. 

  73. </ul>
    74. 

  74. </li>
    75. 

  75. </ul>
    76. 

  76. <ul>
    77. 

  77. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    78. 

  78. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    79. 

  79. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    80. 

  80. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    82. 

  82. </ul>
    83. 

  83. </li>
    84. 

  84. </ul>
    85. 

  85. <ul class="current">
    86. 

  86. <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to CodeIgniter</a><ul>
    87. 

  87. <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    88. 

  88. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    89. 

  89. </ul>
    90. 

  90. </li>
    91. 

  91. </ul>
    92. 

  92. <ul>
    93. 

  93. <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
    94. 

  94. <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
    96. 

  96. <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
    97. 

  97. <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
    98. 

  98. <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
    99. 

  99. <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
    100. 

  100. <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
    101. 

  101. <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
    102. 

  102. <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
    103. 

  103. <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
    104. 

  104. <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
    107. 

  107. <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
    111. 

  111. <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
    112. 

  112. <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
    120. 

  120. </ul>
    121. 

  121. </li>
    122. 

  122. </ul>
    123. 

  123. <ul>
    124. 

  124. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    125. 

  125. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    128. 

  128. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    134. 

  134. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    147. 

  147. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    148. 

  148. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    149. 

  149. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    150. 

  150. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    151. 

  151. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    152. 

  152. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    153. 

  153. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    155. 

  155. </ul>
    156. 

  156. </li>
    157. 

  157. </ul>
    158. 

  158. <ul>
    159. 

  159. <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
    160. 

  160. <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
    161. 

  161. <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
    162. 

  162. <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
    163. 

  163. <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
    164. 

  164. <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
    165. 

  165. <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
    166. 

  166. <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
    167. 

  167. <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
    168. 

  168. <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
    169. 

  169. <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
    170. 

  170. <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
    171. 

  171. <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
    172. 

  172. <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
    173. 

  173. <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
    174. 

  174. </ul>
    175. 

  175. </li>
    176. 

  176. </ul>
    177. 

  177. <ul>
    178. 

  178. <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
    179. 

  179. <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
    180. 

  180. <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
    181. 

  181. <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
    182. 

  182. <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
    183. 

  183. <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
    184. 

  184. <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
    185. 

  185. <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
    186. 

  186. <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
    187. 

  187. <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
    188. 

  188. <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
    189. 

  189. <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
    190. 

  190. <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
    191. 

  191. <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
    192. 

  192. <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
    193. 

  193. <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
    194. 

  194. <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
    195. 

  195. <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
    196. 

  196. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    197. 

  197. <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
    198. 

  198. <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
    199. 

  199. <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
    200. 

  200. </ul>
    201. 

  201. </li>
    202. 

  202. </ul>
    203. 

  203. 

  204.       </div>
    205. 

  205.     
    206. 

  206.       
    207. 

  207.   </div>
    208. 

  208. </div>
    209. 

  209. <div id="nav2">
    210. 

  210.   <a href="#" id="openToc">
    211. 

  211.     <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" />
    212. 

  212.   </a>
    213. 

  213. </div>
    214. 

  214. 

  215.   <div class="wy-grid-for-nav">
    216. 

  216. 

  217.     
    218. 

  218.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    219. 

  219.       <div class="wy-side-nav-search">
    220. 

  220.         
    221. 

  221.           <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
    222. 

  222.         
    223. 

  223.         
    224. 

  224. <div role="search">
    225. 

  225.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    226. 

  226.     <input type="text" name="q" placeholder="Search docs" />
    227. 

  227.     <input type="hidden" name="check_keywords" value="yes" />
    228. 

  228.     <input type="hidden" name="area" value="default" />
    229. 

  229.   </form>
    230. 

  230. </div>
    231. 

  231.       </div>
    232. 

  232. 

  233.       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    234. 

  234.         
    235. 

  235.           
    236. 

  236.           
    237. 

  237.               <ul>
    238. 

  238. <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
    239. 

  239. </ul>
    240. 

  240. <ul>
    241. 

  241. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    242. 

  242. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    243. 

  243. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    244. 

  244. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    245. 

  245. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    246. 

  246. </ul>
    247. 

  247. </li>
    248. 

  248. </ul>
    249. 

  249. <ul>
    250. 

  250. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    251. 

  251. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    252. 

  252. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    253. 

  253. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    254. 

  254. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    255. 

  255. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    256. 

  256. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    257. 

  257. </ul>
    258. 

  258. </li>
    259. 

  259. </ul>
    260. 

  260. <ul>
    261. 

  261. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    262. 

  262. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    263. 

  263. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    264. 

  264. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    265. 

  265. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    266. 

  266. </ul>
    267. 

  267. </li>
    268. 

  268. </ul>
    269. 

  269. <ul class="current">
    270. 

  270. <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to CodeIgniter</a><ul>
    271. 

  271. <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    272. 

  272. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    273. 

  273. </ul>
    274. 

  274. </li>
    275. 

  275. </ul>
    276. 

  276. <ul>
    277. 

  277. <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
    278. 

  278. <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
    279. 

  279. <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
    280. 

  280. <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
    281. 

  281. <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
    282. 

  282. <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
    283. 

  283. <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
    284. 

  284. <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
    285. 

  285. <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
    286. 

  286. <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
    287. 

  287. <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
    288. 

  288. <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
    289. 

  289. <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
    290. 

  290. <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
    291. 

  291. <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
    292. 

  292. <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
    293. 

  293. <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
    294. 

  294. <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
    295. 

  295. <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
    296. 

  296. <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
    297. 

  297. <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
    298. 

  298. <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
    299. 

  299. <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
    300. 

  300. <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
    301. 

  301. <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    302. 

  302. <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
    303. 

  303. <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
    304. 

  304. </ul>
    305. 

  305. </li>
    306. 

  306. </ul>
    307. 

  307. <ul>
    308. 

  308. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    309. 

  309. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    310. 

  310. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    311. 

  311. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    312. 

  312. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    313. 

  313. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    314. 

  314. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    315. 

  315. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    316. 

  316. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    317. 

  317. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    318. 

  318. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    319. 

  319. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    320. 

  320. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    321. 

  321. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    322. 

  322. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    323. 

  323. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    324. 

  324. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    325. 

  325. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    326. 

  326. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    327. 

  327. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    328. 

  328. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    329. 

  329. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    330. 

  330. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    331. 

  331. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    332. 

  332. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    333. 

  333. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    334. 

  334. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    335. 

  335. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    336. 

  336. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    337. 

  337. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    338. 

  338. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    339. 

  339. </ul>
    340. 

  340. </li>
    341. 

  341. </ul>
    342. 

  342. <ul>
    343. 

  343. <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
    344. 

  344. <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
    345. 

  345. <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
    346. 

  346. <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
    347. 

  347. <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
    348. 

  348. <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
    349. 

  349. <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
    350. 

  350. <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
    351. 

  351. <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
    352. 

  352. <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
    353. 

  353. <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
    354. 

  354. <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
    355. 

  355. <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
    356. 

  356. <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
    357. 

  357. <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
    358. 

  358. </ul>
    359. 

  359. </li>
    360. 

  360. </ul>
    361. 

  361. <ul>
    362. 

  362. <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
    363. 

  363. <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
    364. 

  364. <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
    365. 

  365. <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
    366. 

  366. <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
    367. 

  367. <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
    368. 

  368. <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
    369. 

  369. <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
    370. 

  370. <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
    371. 

  371. <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
    372. 

  372. <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
    373. 

  373. <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
    374. 

  374. <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
    375. 

  375. <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
    376. 

  376. <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
    377. 

  377. <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
    378. 

  378. <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
    379. 

  379. <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
    380. 

  380. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    381. 

  381. <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
    382. 

  382. <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
    383. 

  383. <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
    384. 

  384. </ul>
    385. 

  385. </li>
    386. 

  386. </ul>
    387. 

  387. 

  388.           
    389. 

  389.         
    390. 

  390.       </div>
    391. 

  391.       &nbsp;
    392. 

  392.     </nav>
    393. 

  393. 

  394.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    395. 

  395. 

  396.       
    397. 

  397.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    398. 

  398.         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    399. 

  399.         <a href="../index.html">CodeIgniter</a>
    400. 

  400.       </nav>
    401. 

  401. 

  402. 

  403.       
    404. 

  404.       <div class="wy-nav-content">
    405. 

  405.         <div class="rst-content">
    406. 

  406.           <div role="navigation" aria-label="breadcrumbs navigation">
    407. 

  407.   <ul class="wy-breadcrumbs">
    408. 

  408.     <li><a href="../index.html">Docs</a> &raquo;</li>
    409. 

  409.       
    410. 

  410.     <li>Contributing to CodeIgniter</li>
    411. 

  411.     <li class="wy-breadcrumbs-aside">
    412. 

  412.       
    413. 

  413.     </li>
    414. 

  414.     <div style="float:right;margin-left:5px;" id="closeMe">
    415. 

  415.       <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
    416. 

  416.     </div>
    417. 

  417.   </ul>
    418. 

  418.   <hr/>
    419. 

  419. </div>
    420. 

  420.           <div role="main" class="document">
    421. 

  421.             
    422. 

  422.   <div class="section" id="contributing-to-codeigniter">
    423. 

  423. <h1>Contributing to CodeIgniter<a class="headerlink" href="#contributing-to-codeigniter" title="Permalink to this headline">¶</a></h1>
    424. 

  424. <div class="toctree-wrapper compound">
    425. 

  425. <ul>
    426. 

  426. <li class="toctree-l1"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    427. 

  427. <li class="toctree-l1"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    428. 

  428. </ul>
    429. 

  429. </div>
    430. 

  430. <p>CodeIgniter is a community driven project and accepts contributions of code
    431. 

  431. and documentation from the community. These contributions are made in the form
    432. 

  432. of Issues or <a class="reference external" href="https://help.github.com/articles/using-pull-requests/">Pull Requests</a>
    433. 

  433. on the <a class="reference external" href="https://github.com/bcit-ci/CodeIgniter">CodeIgniter repository</a> on GitHub.</p>
    434. 

  434. <p>Issues are a quick way to point out a bug. If you find a bug or documentation
    435. 

  435. error in CodeIgniter then please check a few things first:</p>
    436. 

  436. <ul class="simple">
    437. 

  437. <li>There is not already an open Issue</li>
    438. 

  438. <li>The issue has already been fixed (check the develop branch, or look for
    439. 

  439. closed Issues)</li>
    440. 

  440. <li>Is it something really obvious that you fix it yourself?</li>
    441. 

  441. </ul>
    442. 

  442. <p>Reporting issues is helpful but an even better approach is to send a Pull
    443. 

  443. Request, which is done by “Forking” the main repository and committing to your
    444. 

  444. own copy. This will require you to use the version control system called Git.</p>
    445. 

  445. <div class="section" id="support">
    446. 

  446. <h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
    447. 

  447. <p>Please note that GitHub is not for general support questions! If you are
    448. 

  448. having trouble using a feature of CodeIgniter, ask for help on our
    449. 

  449. <a class="reference external" href="http://forum.codeigniter.com/">forums</a> instead.</p>
    450. 

  450. <p>If you are not sure whether you are using something correctly or if you
    451. 

  451. have found a bug, again - please ask on the forums first.</p>
    452. 

  452. </div>
    453. 

  453. <div class="section" id="security">
    454. 

  454. <h2>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h2>
    455. 

  455. <p>Did you find a security issue in CodeIgniter?</p>
    456. 

  456. <p>Please <em>don’t</em> disclose it publicly, but e-mail us at <a class="reference external" href="mailto:security&#37;&#52;&#48;codeigniter&#46;com">security<span>&#64;</span>codeigniter<span>&#46;</span>com</a>,
    457. 

  457. or report it via our page on <a class="reference external" href="https://hackerone.com/codeigniter">HackerOne</a>.</p>
    458. 

  458. <p>If you’ve found a critical vulnerability, we’d be happy to credit you in our
    459. 

  459. <cite>ChangeLog &lt;../changelog&gt;</cite>.</p>
    460. 

  460. </div>
    461. 

  461. <div class="section" id="tips-for-a-good-issue-report">
    462. 

  462. <h2>Tips for a Good Issue Report<a class="headerlink" href="#tips-for-a-good-issue-report" title="Permalink to this headline">¶</a></h2>
    463. 

  463. <p>Use a descriptive subject line (eg parser library chokes on commas) rather than a vague one (eg. your code broke).</p>
    464. 

  464. <p>Address a single issue in a report.</p>
    465. 

  465. <p>Identify the CodeIgniter version (eg 3.0-develop) and the component if you know it (eg. parser library)</p>
    466. 

  466. <p>Explain what you expected to happen, and what did happen.
    467. 

  467. Include error messages and stacktrace, if any.</p>
    468. 

  468. <p>Include short code segments if they help to explain.
    469. 

  469. Use a pastebin or dropbox facility to include longer segments of code or screenshots - do not include them in the issue report itself.
    470. 

  470. This means setting a reasonable expiry for those, until the issue is resolved or closed.</p>
    471. 

  471. <p>If you know how to fix the issue, you can do so in your own fork &amp; branch, and submit a pull request.
    472. 

  472. The issue report information above should be part of that.</p>
    473. 

  473. <p>If your issue report can describe the steps to reproduce the problem, that is great.
    474. 

  474. If you can include a unit test that reproduces the problem, that is even better, as it gives whoever is fixing
    475. 

  475. it a clearer target!</p>
    476. 

  476. </div>
    477. 

  477. <div class="section" id="guidelines">
    478. 

  478. <h2>Guidelines<a class="headerlink" href="#guidelines" title="Permalink to this headline">¶</a></h2>
    479. 

  479. <p>Before we look into how, here are the guidelines. If your Pull Requests fail
    480. 

  480. to pass these guidelines it will be declined and you will need to re-submit
    481. 

  481. when you’ve made the changes. This might sound a bit tough, but it is required
    482. 

  482. for us to maintain quality of the code-base.</p>
    483. 

  483. <div class="section" id="php-style">
    484. 

  484. <h3>PHP Style<a class="headerlink" href="#php-style" title="Permalink to this headline">¶</a></h3>
    485. 

  485. <p>All code must meet the <a class="reference external" href="https://codeigniter.com/userguide3/general/styleguide.html">Style Guide</a>, which is
    486. 

  486. essentially the <a class="reference external" href="https://en.wikipedia.org/wiki/Indent_style#Allman_style">Allman indent style</a>, underscores and
    487. 

  487. readable operators. This makes certain that all code is the same format as the
    488. 

  488. existing code and means it will be as readable as possible.</p>
    489. 

  489. </div>
    490. 

  490. <div class="section" id="documentation">
    491. 

  491. <h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h3>
    492. 

  492. <p>If you change anything that requires a change to documentation then you will
    493. 

  493. need to add it. New classes, methods, parameters, changing default values, etc
    494. 

  494. are all things that will require a change to documentation. The change-log
    495. 

  495. must also be updated for every change. Also PHPDoc blocks must be maintained.</p>
    496. 

  496. </div>
    497. 

  497. <div class="section" id="compatibility">
    498. 

  498. <h3>Compatibility<a class="headerlink" href="#compatibility" title="Permalink to this headline">¶</a></h3>
    499. 

  499. <p>CodeIgniter recommends PHP 5.6 or newer to be used, but it should be
    500. 

  500. compatible with PHP 5.3.7 so all code supplied must stick to this
    501. 

  501. requirement. If PHP 5.4 (and above) functions or features are used then
    502. 

  502. there must be a fallback for PHP 5.3.7.</p>
    503. 

  503. </div>
    504. 

  504. <div class="section" id="branching">
    505. 

  505. <h3>Branching<a class="headerlink" href="#branching" title="Permalink to this headline">¶</a></h3>
    506. 

  506. <p>CodeIgniter uses the <a class="reference external" href="http://nvie.com/posts/a-successful-git-branching-model/">Git-Flow</a> branching model
    507. 

  507. which requires all pull requests to be sent to the “develop” branch. This is
    508. 

  508. where the next planned version will be developed. The “master” branch will
    509. 

  509. always contain the latest stable version and is kept clean so a “hotfix” (e.g:
    510. 

  510. an emergency security patch) can be applied to master to create a new version,
    511. 

  511. without worrying about other features holding it up. For this reason all
    512. 

  512. commits need to be made to “develop” and any sent to “master” will be closed
    513. 

  513. automatically. If you have multiple changes to submit, please place all
    514. 

  514. changes into their own branch on your fork.</p>
    515. 

  515. <p>One thing at a time: A pull request should only contain one change. That does
    516. 

  516. not mean only one commit, but one change - however many commits it took. The
    517. 

  517. reason for this is that if you change X and Y but send a pull request for both
    518. 

  518. at the same time, we might really want X but disagree with Y, meaning we
    519. 

  519. cannot merge the request. Using the Git-Flow branching model you can create
    520. 

  520. new branches for both of these features and send two requests.</p>
    521. 

  521. </div>
    522. 

  522. <div class="section" id="signing">
    523. 

  523. <h3>Signing<a class="headerlink" href="#signing" title="Permalink to this headline">¶</a></h3>
    524. 

  524. <p>You must sign your work, certifying that you either wrote the work or
    525. 

  525. otherwise have the right to pass it on to an open source project. git makes
    526. 

  526. this trivial as you merely have to use <cite>–signoff</cite> on your commits to your
    527. 

  527. CodeIgniter fork.</p>
    528. 

  528. <div class="highlight-bash"><div class="highlight"><pre><span></span>git commit --signoff
    529. 

  529. </pre></div>
    530. 

  530. </div>
    531. 

  531. <p>or simply</p>
    532. 

  532. <div class="highlight-bash"><div class="highlight"><pre><span></span>git commit -s
    533. 

  533. </pre></div>
    534. 

  534. </div>
    535. 

  535. <p>This will sign your commits with the information setup in your git config, e.g.</p>
    536. 

  536. <blockquote>
    537. 

  537. <div>Signed-off-by: John Q Public &lt;<a class="reference external" href="mailto:john&#46;public&#37;&#52;&#48;example&#46;com">john<span>&#46;</span>public<span>&#64;</span>example<span>&#46;</span>com</a>&gt;</div></blockquote>
    538. 

  538. <p>If you are using Tower there is a “Sign-Off” checkbox in the commit window. You
    539. 

  539. could even alias git commit to use the -s flag so you don’t have to think about
    540. 

  540. it.</p>
    541. 

  541. <p>By signing your work in this manner, you certify to a “Developer’s Certificate
    542. 

  542. of Origin”. The current version of this certificate is in the <a class="reference internal" href="../DCO.html"><span class="doc">Developer’s Certificate of Origin 1.1</span></a> file
    543. 

  543. in the root of this documentation.</p>
    544. 

  544. </div>
    545. 

  545. </div>
    546. 

  546. </div>
    547. 

  547. 

  548. 

  549.           </div>
    550. 

  550.           <footer>
    551. 

  551.   
    552. 

  552.     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
    553. 

  553.       
    554. 

  554.         <a href="../documentation/index.html" class="btn btn-neutral float-right" title="Writing CodeIgniter Documentation">Next <span class="fa fa-arrow-circle-right"></span></a>
    555. 

  555.       
    556. 

  556.       
    557. 

  557.         <a href="../tutorial/conclusion.html" class="btn btn-neutral" title="Conclusion"><span class="fa fa-arrow-circle-left"></span> Previous</a>
    558. 

  558.       
    559. 

  559.     </div>
    560. 

  560.   
    561. 

  561. 

  562.   <hr/>
    563. 

  563. 

  564.   <div role="contentinfo">
    565. 

  565.     <p>
    566. 

  566.         &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
    567. 

  567.       Last updated on Sep 19, 2019.
    568. 

  568.     </p>
    569. 

  569.   </div>
    570. 

  570. 

  571.   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
    572. 

  572.   
    573. 

  573. </footer>
    574. 

  574.         </div>
    575. 

  575.       </div>
    576. 

  576. 

  577.     </section>
    578. 

  578. 

  579.   </div>
    580. 

  580.   
    581. 

  581. 

  582. 

  583.   
    584. 

  584. 

  585.     <script type="text/javascript">
    586. 

  586.         var DOCUMENTATION_OPTIONS = {
    587. 

  587.             URL_ROOT:'../',
    588. 

  588.             VERSION:'3.1.11',
    589. 

  589.             COLLAPSE_INDEX:false,
    590. 

  590.             FILE_SUFFIX:'.html',
    591. 

  591.             HAS_SOURCE:  false
    592. 

  592.         };
    593. 

  593.     </script>
    594. 

  594.       <script type="text/javascript" src="../_static/jquery.js"></script>
    595. 

  595.       <script type="text/javascript" src="../_static/underscore.js"></script>
    596. 

  596.       <script type="text/javascript" src="../_static/doctools.js"></script>
    597. 

  597. 

  598.   
    599. 

  599. 

  600.   
    601. 

  601.   
    602. 

  602.     <script type="text/javascript" src="../_static/js/theme.js"></script>
    603. 

  603.   
    604. 

  604. 

  605.   
    606. 

  606.   
    607. 

  607.   <script type="text/javascript">
    608. 

  608.       jQuery(function () {
    609. 

  609.           SphinxRtdTheme.StickyNav.enable();
    610. 

  610.       });
    611. 

  611.   </script>
    612. 

  612.    
    613. 

  613. 

  614. </body>
    615. 

  615. </html>
    616.