Docs/contributing

contributing.md

@@ -5,7 +5,7 @@
 
 We expect all contributions to conform to our style guide, be commented (inside the PHP source files), 
 be documented (in the user guide), and unit tested (in the test folder). 
-There is a [Contributing to CodeIgniter](https://bcit-ci.github.io/CodeIgniter4/contributing/index.html) section in the user guide which describes the contribution process; this page is an overview.
+There is a [Contributing to CodeIgniter](./contributing/index.rst) section in the repository which describes the contribution process; this page is an overview.
 
 ## Issues
 

user_guide_src/source/contributing/guidelines.rst → contributing/guidelines.rst

@@ -11,7 +11,7 @@ PHP Style
 =========
 
 All code must conform to our `Style Guide
-<./styleguide.html>`_, which is
+<./styleguide.rst>`_, which is
 essentially the `Allman indent style
 <https://en.wikipedia.org/wiki/Indent_style#Allman_style>`_, with
 elaboration on naming and readable operators.
@@ -50,10 +50,6 @@ class/interface/trait, method and variable.
 
 See the `phpDocumentor website <https://phpdoc.org/>`_ for more information.
 
-We use ``phpDocumentor2`` to generate the API documentation for the
-framework, with configuration details in ``phpdoc.dist.xml`` in the project
-root.
-
 Documentation
 =============
 
@@ -77,21 +73,15 @@ for an example.
 PHP Compatibility
 =================
 
-CodeIgniter4 requires PHP 7.
-
-See the `CodeIgniter4-developer-setup <https://github.com/bcit-ci/CodeIgniter4-developer-setup>`_
-repository for tips on setting this up on your system.
-
-That repository also contains tips for configuring your IDE or editor to work
-better with PHP7 and CodeIgniter4.
+CodeIgniter4 requires PHP 7.1.
 
 Backwards Compatibility
 =======================
 
 Generally, we aim to maintain backwards compatibility between minor
 versions of the framework. Any changes that break compatibility need
 a good reason to do so, and need to be pointed out in the
-`Upgrading <../installation/upgrading.html>`_ guide.
+`Upgrading <https://bcit-ci.github.io/CodeIgniter4/installation/upgrading.html>`_ guide.
 
 CodeIgniter4 itself represents a significant backwards compatibility break
 with earlier versions of the framework.
@@ -102,6 +92,7 @@ Mergeability
 Your PRs need to be mergeable before they will be considered.
 
 We suggest that you synchronize your repository's ``develop`` branch with
-that in the main repository before submitting a PR.
+that in the main repository, and then your feature branch and
+your develop branch, before submitting a PR.
 You will need to resolve any merge conflicts introduced by changes
 incorporated since you started working on your contribution.

user_guide_src/source/contributing/index.rst → contributing/index.rst

@@ -2,17 +2,13 @@
 Contributing to CodeIgniter
 ###########################
 
-.. toctree::
-    :titlesonly:
-
-    guidelines
-    workflow
-    signing
-    roadmap
-    internals
-    documentation
-    PHP Style Guide <styleguide>
-    ../DCO
+- `Contribution guidelines <./guidelines.rst>`_
+- `Contribution workflow <./workflow.rst>`_
+- `Contribution signing <./signing.rst>`_
+- `Framework internals <./internals.rst>`_
+- `CodeIgniter documentation <./documentation.rst>`_
+- `PHP Style Guide <./styleguide.rst>`_
+- `Developer's Certificate of Origin <../DCO.txt>`_
 
 CodeIgniter is a community driven project and accepts contributions of code
 and documentation from the community. These contributions are made in the form
@@ -52,7 +48,7 @@ Please *don't* disclose it publicly, but e-mail us at security@codeigniter.com,
 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 <../changelog.html>`_.
+`ChangeLog <https://bcit-ci.github.io/CodeIgniter4/changelog.html>`_.
 
 ****************************
 Tips for a Good Issue Report
@@ -62,7 +58,7 @@ Use a descriptive subject line (eg parser library chokes on commas) rather than
 
 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)
+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.

user_guide_src/source/contributing/signing.rst → contributing/signing.rst

@@ -30,50 +30,10 @@ contributions be securely signed.
 
 Read below to find out how to sign your commits :)
 
-Basic Signing
-=============
-You must sign your work, certifying that you either wrote the work or
-otherwise have the right to pass it on to an open source project.
-
-Setup your commit message user name and email address. See
-`Setting your email in Git <https://help.github.com/articles/setting-your-email-in-git/>`_
-to set these up globally or for a single repository.
-
-.. code-block:: bash
-
-	git config --global user.email "john.public@example.com"
-	git config --global user.name "John Q Public"
-
-Once in place, you merely have to use `--signoff` on your commits to your
-CodeIgniter fork.
-
-.. code-block:: bash
-
-	git commit --signoff
-
-or simply
-
-.. code-block:: bash
-
-	git commit -s
-
-This will sign your commits with the information setup in your git config, e.g.
-
-	Signed-off-by: John Q Public <john.public@example.com>
-
-Your IDE may have a "Sign-Off" checkbox in the commit window,
-or even an option to automatically sign-off all commits you make. You
-could even alias git commit to use the -s flag so you don’t have to think about
-it.
-
-By signing your work in this manner, you certify to a "Developer's Certificate
-of Origin". The current version of this certificate is in the :doc:`/DCO` file
-in the root of this documentation.
 
 Secure Signing
 ==============
 
-The "basic signing" described above cannot be verified, though it is a great start.
 To verify your commits, you will need to
 setup a GPG key, and attach it to your github account.
 
@@ -104,5 +64,4 @@ The audience for your commit messages will be the codebase maintainers, any
 code reviewers, and debuggers trying to figure out when a bug might have been
 introduced.
 
-Do try to make your commit messages meaningful.
-.
+Make your commit messages meaningful.

user_guide_src/source/contributing/styleguide.rst → contributing/styleguide.rst

@@ -20,11 +20,6 @@ PSR-2 is PHP-FIG's Coding Style Guide. We do not claim conformance with it,
 although there are a lot of similarities. The differences will be pointed out
 below.
 
-.. note:: See the
-    `CodeIgniter4-developer-setup <https://github.com/bcit-ci/CodeIgniter4-developer-setup>`_
-    repository for tips on configuring your IDE or editor to help you conform
-    to the style guide.
-
 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
 "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to
 be interpreted as described in `RFC 2119 <http://www.ietf.org/rfc/rfc2119.txt>`_.

user_guide_src/source/index.rst

@@ -92,12 +92,3 @@ Testing
 	:titlesonly:
 
 	testing/index
-
-***************************
-Contributing to CodeIgniter
-***************************
-
-.. toctree::
-	:titlesonly:
-
-	contributing/index