Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contributing reference to user guide #1280

Merged
merged 1 commit into from
Oct 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
71 changes: 71 additions & 0 deletions user_guide_src/source/extending/contributing.rst
Original file line number Diff line number Diff line change
@@ -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 <https://help.github.com/articles/using-pull-requests/>`_
on the `CodeIgniter4 repository <https://github.com/bcit-ci/CodeIgniter4>`_ 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 <https://github.com/bcit-ci/CodeIgniter4/tree/develop/contributing>`_
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 <http://forum.codeigniter.com/>`_ 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 [email protected],
or report it via our page on `HackerOne <https://hackerone.com/codeigniter>`_.

If you've found a critical vulnerability, we'd be happy to credit you in our
`ChangeLog <https://bcit-ci.github.io/CodeIgniter4/changelog.html>`_.

****************************
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!
1 change: 1 addition & 0 deletions user_guide_src/source/extending/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ CodeIgniter 4 has been designed to be easy to extend or build upon.

core_classes
events
contributing
3 changes: 3 additions & 0 deletions user_guide_src/source/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </intro/requirements>`.

Manual Installation
===================

Expand Down
10 changes: 9 additions & 1 deletion user_guide_src/source/intro/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@
Server Requirements
###################

`PHP <http://php.net/>`_ version 7.1 or newer is required, with the *intl* extension installed. `Why 7.1 <https://gophp71.org/>`_?
`PHP <http://php.net/>`_ version 7.1 or newer is required, with the
`*intl* extension <http://php.net/manual/en/intl.requirements.php>`_
installed. `Why 7.1 <https://gophp71.org/>`_?

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 </libraries/curlrequest>`, you will need
`libcurl <http://php.net/manual/en/curl.requirements.php>`_ installed.

A database is required for most web application programming.
Currently supported databases are:
Expand Down