From 8f75f7fdd14acef06f591ce03163ef5937c3b612 Mon Sep 17 00:00:00 2001 From: Claudio Galdiolo Date: Wed, 11 Nov 2015 10:20:42 -0500 Subject: [ci skip] Make it clear that PHP <5.5 usage is discouraged PHP 5.4 reached end of life Signed-off-by: Claudio Galdiolo --- contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 5a25698bf..f4d6705ed 100644 --- a/contributing.md +++ b/contributing.md @@ -29,7 +29,7 @@ If you change anything that requires a change to documentation then you will nee ### Compatibility -CodeIgniter recommends PHP 5.4 or newer to be used, but it should be +CodeIgniter recommends PHP 5.5 or newer to be used, but it should be compatible with PHP 5.2.4 so all code supplied must stick to this requirement. If PHP 5.3 (and above) functions or features are used then there must be a fallback for PHP 5.2.4. -- cgit v1.2.3-24-g4f1b From a425963d769984a7f97f088ce1eb3db27d933cfa Mon Sep 17 00:00:00 2001 From: Vinod Selvin Date: Sun, 5 Nov 2017 19:30:24 +0530 Subject: Bug in documentation when i clicked on Codeigniter repository on Contributing.md, it redirects to https://github.com/bcit-ci/CodeIgniter>, there is some extra greater than symbol, creating issue, so i fixed and creating pull request to you. --- contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 10b89b1db..d0df9b966 100644 --- a/contributing.md +++ b/contributing.md @@ -1,7 +1,7 @@ # 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](http://help.github.com/send-pull-requests/) on the [CodeIgniter repository](https://github.com/bcit-ci/CodeIgniter>) on GitHub. +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](http://help.github.com/send-pull-requests/) on the [CodeIgniter repository](https://github.com/bcit-ci/CodeIgniter) 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: @@ -92,4 +92,4 @@ If you are using command-line you can do the following: 2. `git pull codeigniter develop` 3. `git push origin develop` -Now your fork is up to date. This should be done regularly, or before you send a pull request at least. \ No newline at end of file +Now your fork is up to date. This should be done regularly, or before you send a pull request at least. -- cgit v1.2.3-24-g4f1b From 52a87e506d4fc70bd5922b07a532852d28f28ab6 Mon Sep 17 00:00:00 2001 From: Mehdi Bounya Date: Thu, 17 May 2018 23:41:30 +0000 Subject: http:// to https:// --- contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index d0df9b966..65ff9501a 100644 --- a/contributing.md +++ b/contributing.md @@ -36,7 +36,7 @@ there must be a fallback for PHP 5.2.4. ### Branching -CodeIgniter uses the [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all pull requests to be sent to the "develop" branch. This is +CodeIgniter uses the [Git-Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all pull requests to be sent to the "develop" branch. This is where the next planned version will be developed. The "master" branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g: an emergency security patch) can be applied to master to create a new version, without worrying about other features holding it up. For this reason all commits need to be made to "develop" and any sent to "master" will be closed automatically. If you have multiple changes to submit, please place all changes into their own branch on your fork. One thing at a time: A pull request should only contain one change. That does not mean only one commit, but one change - however many commits it took. The reason for this is that if you change X and Y but send a pull request for both at the same time, we might really want X but disagree with Y, meaning we cannot merge the request. Using the Git-Flow branching model you can create new branches for both of these features and send two requests. @@ -55,7 +55,7 @@ This will sign your commits with the information setup in your git config, e.g. `Signed-off-by: John Q Public ` -If you are using [Tower](http://www.git-tower.com/) there is a "Sign-Off" checkbox in the commit window. You could even alias git commit to use the `-s` flag so you don’t have to think about it. +If you are using [Tower](https://www.git-tower.com/) there is a "Sign-Off" checkbox in the commit window. 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 `DCO.txt` file in the root of this repository. -- cgit v1.2.3-24-g4f1b From 73cde1994aad64a32d19d8b2e11f1b82ccaad19d Mon Sep 17 00:00:00 2001 From: Brendan Corazzin Date: Mon, 13 May 2019 09:32:29 -0500 Subject: Fixed broken 'Send a pull request' link and added links to official GitHub documentation for other steps in the 'How-to Guide'. Additional links were added to make the How-to Guide a little more user friendly for those who are unfamilar to GitHub. --- contributing.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 65ff9501a..46ce0190e 100644 --- a/contributing.md +++ b/contributing.md @@ -1,6 +1,5 @@ # 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](http://help.github.com/send-pull-requests/) on the [CodeIgniter repository](https://github.com/bcit-ci/CodeIgniter) 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: @@ -59,7 +58,6 @@ If you are using [Tower](https://www.git-tower.com/) there is a "Sign-Off" check 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 `DCO.txt` file in the root of this repository. - ## How-to Guide There are two ways to make changes, the easy way and the hard way. Either way you will need to [create a GitHub account](https://github.com/signup/free). @@ -68,15 +66,15 @@ Easy way GitHub allows in-line editing of files for making simple typo changes a Hard way The best way to contribute is to "clone" your fork of CodeIgniter to your development area. That sounds like some jargon, but "forking" on GitHub means "making a copy of that repo to your account" and "cloning" means "copying that code to your environment so you can work on it". -1. Set up Git (Windows, Mac & Linux) -2. Go to the CodeIgniter repo -3. Fork it -4. Clone your CodeIgniter repo: git@github.com:/CodeIgniter.git -5. Checkout the "develop" branch At this point you are ready to start making changes. +1. [Set up Git](https://help.github.com/en/articles/set-up-git) (Windows, Mac & Linux) +2. Go to the [CodeIgniter repo](https://github.com/bcit-ci/CodeIgniter) +3. [Fork it](https://help.github.com/en/articles/fork-a-repo) +4. [Clone](https://help.github.com/en/articles/fetching-a-remote#clone) your forked CodeIgniter repo. +5. Checkout the "develop" branch. At this point you are ready to start making changes. 6. Fix existing bugs on the Issue tracker after taking a look to see nobody else is working on them. -7. Commit the files -8. Push your develop branch to your fork -9. Send a pull request [http://help.github.com/send-pull-requests/](http://help.github.com/send-pull-requests/) +7. [Commit](https://help.github.com/en/articles/adding-a-file-to-a-repository-using-the-command-line) the files +8. [Push](https://help.github.com/en/articles/pushing-to-a-remote) your develop branch to your fork +9. [Send a pull request](https://help.github.com/en/articles/creating-a-pull-request) The Reactor Engineers will now be alerted about the change and at least one of the team will respond. If your change fails to meet the guidelines it will be bounced, or feedback will be provided to help you improve it. -- cgit v1.2.3-24-g4f1b From 2eff8a25cc06f35ae8a5e5efebfc7fa739ed7fae Mon Sep 17 00:00:00 2001 From: Brendan Corazzin Date: Tue, 28 May 2019 14:43:44 -0500 Subject: Adding back 'git@github.com:/CodeIgniter.git' to step 4 in the how-to guide --- contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 46ce0190e..8f43c45a6 100644 --- a/contributing.md +++ b/contributing.md @@ -69,7 +69,7 @@ Hard way The best way to contribute is to "clone" your fork of CodeIgniter to yo 1. [Set up Git](https://help.github.com/en/articles/set-up-git) (Windows, Mac & Linux) 2. Go to the [CodeIgniter repo](https://github.com/bcit-ci/CodeIgniter) 3. [Fork it](https://help.github.com/en/articles/fork-a-repo) -4. [Clone](https://help.github.com/en/articles/fetching-a-remote#clone) your forked CodeIgniter repo. +4. [Clone](https://help.github.com/en/articles/fetching-a-remote#clone) your forked CodeIgniter repo: git@github.com:/CodeIgniter.git. 5. Checkout the "develop" branch. At this point you are ready to start making changes. 6. Fix existing bugs on the Issue tracker after taking a look to see nobody else is working on them. 7. [Commit](https://help.github.com/en/articles/adding-a-file-to-a-repository-using-the-command-line) the files -- cgit v1.2.3-24-g4f1b From 6ba0207160f8f2b99c79dd285bccf45f574ec660 Mon Sep 17 00:00:00 2001 From: sapics Date: Wed, 24 Jun 2020 11:51:36 +0900 Subject: Fix user guide url Replace from https://codeigniter.com/user_guide/* to https://codeigniter.com/userguide3/* --- contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index 8f43c45a6..206784d1f 100644 --- a/contributing.md +++ b/contributing.md @@ -19,7 +19,7 @@ for us to maintain quality of the code-base. ### PHP Style -All code must meet the [Style Guide](https://codeigniter.com/user_guide/general/styleguide.html), which is +All code must meet the [Style Guide](https://codeigniter.com/userguide3/general/styleguide.html), which is essentially the [Allman indent style](https://en.wikipedia.org/wiki/Indent_style#Allman_style), underscores and readable operators. This makes certain that all code is the same format as the existing code and means it will be as readable as possible. ### Documentation -- cgit v1.2.3-24-g4f1b