Skip to content

Commit ccdc58f

Browse files
committed
Split contributing docs from user guide
1 parent 1e1e34e commit ccdc58f

4 files changed

Lines changed: 7 additions & 63 deletions

File tree

contributing/guidelines.rst

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ PHP Style
1111
=========
1212

1313
All code must conform to our `Style Guide
14-
<./styleguide.html>`_, which is
14+
<./styleguide.rst>`_, which is
1515
essentially the `Allman indent style
1616
<https://en.wikipedia.org/wiki/Indent_style#Allman_style>`_, with
1717
elaboration on naming and readable operators.
@@ -50,10 +50,6 @@ class/interface/trait, method and variable.
5050

5151
See the `phpDocumentor website <https://phpdoc.org/>`_ for more information.
5252

53-
We use ``phpDocumentor2`` to generate the API documentation for the
54-
framework, with configuration details in ``phpdoc.dist.xml`` in the project
55-
root.
56-
5753
Documentation
5854
=============
5955

@@ -77,21 +73,15 @@ for an example.
7773
PHP Compatibility
7874
=================
7975

80-
CodeIgniter4 requires PHP 7.
81-
82-
See the `CodeIgniter4-developer-setup <https://github.com/bcit-ci/CodeIgniter4-developer-setup>`_
83-
repository for tips on setting this up on your system.
84-
85-
That repository also contains tips for configuring your IDE or editor to work
86-
better with PHP7 and CodeIgniter4.
76+
CodeIgniter4 requires PHP 7.1.
8777

8878
Backwards Compatibility
8979
=======================
9080

9181
Generally, we aim to maintain backwards compatibility between minor
9282
versions of the framework. Any changes that break compatibility need
9383
a good reason to do so, and need to be pointed out in the
94-
`Upgrading <../installation/upgrading.html>`_ guide.
84+
`Upgrading <https://bcit-ci.github.io/CodeIgniter4/installation/upgrading.html>`_ guide.
9585

9686
CodeIgniter4 itself represents a significant backwards compatibility break
9787
with earlier versions of the framework.
@@ -102,6 +92,7 @@ Mergeability
10292
Your PRs need to be mergeable before they will be considered.
10393

10494
We suggest that you synchronize your repository's ``develop`` branch with
105-
that in the main repository before submitting a PR.
95+
that in the main repository, and then your feature branch and
96+
your develop branch, before submitting a PR.
10697
You will need to resolve any merge conflicts introduced by changes
10798
incorporated since you started working on your contribution.

contributing/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ Contributing to CodeIgniter
88
guidelines
99
workflow
1010
signing
11-
roadmap
1211
internals
1312
documentation
1413
PHP Style Guide <styleguide>
@@ -52,7 +51,7 @@ Please *don't* disclose it publicly, but e-mail us at security@codeigniter.com,
5251
or report it via our page on `HackerOne <https://hackerone.com/codeigniter>`_.
5352

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

5756
****************************
5857
Tips for a Good Issue Report
@@ -62,7 +61,7 @@ Use a descriptive subject line (eg parser library chokes on commas) rather than
6261

6362
Address a single issue in a report.
6463

65-
Identify the CodeIgniter version (eg 3.0-develop) and the component if you know it (eg. parser library)
64+
Identify the CodeIgniter version (eg 4.0.1) and the component if you know it (eg. parser library)
6665

6766
Explain what you expected to happen, and what did happen.
6867
Include error messages and stacktrace, if any.

contributing/signing.rst

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -30,50 +30,10 @@ contributions be securely signed.
3030

3131
Read below to find out how to sign your commits :)
3232

33-
Basic Signing
34-
=============
35-
You must sign your work, certifying that you either wrote the work or
36-
otherwise have the right to pass it on to an open source project.
37-
38-
Setup your commit message user name and email address. See
39-
`Setting your email in Git <https://help.github.com/articles/setting-your-email-in-git/>`_
40-
to set these up globally or for a single repository.
41-
42-
.. code-block:: bash
43-
44-
git config --global user.email "john.public@example.com"
45-
git config --global user.name "John Q Public"
46-
47-
Once in place, you merely have to use `--signoff` on your commits to your
48-
CodeIgniter fork.
49-
50-
.. code-block:: bash
51-
52-
git commit --signoff
53-
54-
or simply
55-
56-
.. code-block:: bash
57-
58-
git commit -s
59-
60-
This will sign your commits with the information setup in your git config, e.g.
61-
62-
Signed-off-by: John Q Public <john.public@example.com>
63-
64-
Your IDE may have a "Sign-Off" checkbox in the commit window,
65-
or even an option to automatically sign-off all commits you make. You
66-
could even alias git commit to use the -s flag so you don’t have to think about
67-
it.
68-
69-
By signing your work in this manner, you certify to a "Developer's Certificate
70-
of Origin". The current version of this certificate is in the :doc:`/DCO` file
71-
in the root of this documentation.
7233

7334
Secure Signing
7435
==============
7536

76-
The "basic signing" described above cannot be verified, though it is a great start.
7737
To verify your commits, you will need to
7838
setup a GPG key, and attach it to your github account.
7939

@@ -105,4 +65,3 @@ code reviewers, and debuggers trying to figure out when a bug might have been
10565
introduced.
10666

10767
Do try to make your commit messages meaningful.
108-
.

contributing/styleguide.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ PSR-2 is PHP-FIG's Coding Style Guide. We do not claim conformance with it,
2020
although there are a lot of similarities. The differences will be pointed out
2121
below.
2222

23-
.. note:: See the
24-
`CodeIgniter4-developer-setup <https://github.com/bcit-ci/CodeIgniter4-developer-setup>`_
25-
repository for tips on configuring your IDE or editor to help you conform
26-
to the style guide.
27-
2823
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
2924
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to
3025
be interpreted as described in `RFC 2119 <http://www.ietf.org/rfc/rfc2119.txt>`_.

0 commit comments

Comments
 (0)