diff --git a/contributing/index.rst b/contributing/README.rst similarity index 100% rename from contributing/index.rst rename to contributing/README.rst diff --git a/user_guide_src/source/extending/contributing.rst b/user_guide_src/source/extending/contributing.rst new file mode 100644 index 000000000000..bd5a90668f82 --- /dev/null +++ b/user_guide_src/source/extending/contributing.rst @@ -0,0 +1,71 @@ +########################### +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 `_ +on the `CodeIgniter4 repository `_ 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: + +- There is not already an open Issue +- The issue has already been fixed (check the develop branch, or look for + closed Issues) +- Is it something really obvious that you fix it yourself? + +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. + +Please see the `Contributing to CodeIgniter4 `_ +section of our code repository. + + +******* +Support +******* + +Please note that GitHub is not for general support questions! If you are +having trouble using a feature of CodeIgniter, ask for help on our +`forums `_ instead. + +If you are not sure whether you are using something correctly or if you +have found a bug, again - please ask on the forums first. + +******** +Security +******** + +Did you find a security issue in CodeIgniter? + +Please *don't* disclose it publicly, but e-mail us at security@codeigniter.com, +or report it via our page on `HackerOne `_. + +If you've found a critical vulnerability, we'd be happy to credit you in our +`ChangeLog `_. + +**************************** +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 4.0.1) 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! diff --git a/user_guide_src/source/extending/index.rst b/user_guide_src/source/extending/index.rst index adbf8b11cea3..d15352ccacf4 100644 --- a/user_guide_src/source/extending/index.rst +++ b/user_guide_src/source/extending/index.rst @@ -9,3 +9,4 @@ CodeIgniter 4 has been designed to be easy to extend or build upon. core_classes events + contributing diff --git a/user_guide_src/source/installation/index.rst b/user_guide_src/source/installation/index.rst index e4cdc8e5e86b..86c038598be5 100644 --- a/user_guide_src/source/installation/index.rst +++ b/user_guide_src/source/installation/index.rst @@ -4,6 +4,9 @@ Installation CodeIgniter4 can be installed manually, or using Composer. +.. note:: Before using CodeIgniter, make sure that your server meets the + :doc:`requirements `. + Manual Installation =================== diff --git a/user_guide_src/source/intro/requirements.rst b/user_guide_src/source/intro/requirements.rst index 68d3f12406c1..246042f1cf2c 100644 --- a/user_guide_src/source/intro/requirements.rst +++ b/user_guide_src/source/intro/requirements.rst @@ -2,7 +2,15 @@ Server Requirements ################### -`PHP `_ version 7.1 or newer is required, with the *intl* extension installed. `Why 7.1 `_? +`PHP `_ version 7.1 or newer is required, with the +`*intl* extension `_ +installed. `Why 7.1 `_? + +The following PHP extensions should be enabled on your server: +``php-json``, ``php-mbstring``, ``php-mysqlnd``, `php-xml`` + +In order to use the :doc:`CURLRequest `, you will need +`libcurl `_ installed. A database is required for most web application programming. Currently supported databases are: