From 582fe381528899df2281633f313c1e697f1664e1 Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Thu, 16 May 2019 11:21:35 -0500 Subject: [PATCH 1/8] Update README.md Updated the README a bit to make the project more inviting to new FOSS contributors. --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c8cf30ef8a69..2e568971a4f9 100644 --- a/README.md +++ b/README.md @@ -65,13 +65,13 @@ to optional packages, with their own repository. We **are** accepting contributions from the community, specifically those identified as part of phase 2. -We will try to manage the process somewhat, by adding a "Help wanted" label to those that we are -specifically interested in at any point in time. Join the discussion for those issues, and let us know -if you want to take the lead for one of them. +We will try to manage the process somewhat, by adding a ["help wanted" label](https://github.com/codeigniter4/CodeIgniter4/labels/help%20wanted) to those that we are +specifically interested in at any point in time. Join the discussion for those issues and let us know +if you want to take the lead on one of them. -We are not looking for out-of-scope contributions, only those that would be considered part of our controlled evolution! +At this time, we are not looking for out-of-scope contributions, only those that would be considered part of our controlled evolution! -Please read the [*Contributing to CodeIgniter*](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing.md) section in the user guide +Please read the [*Contributing to CodeIgniter*](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing.md) section in the user guide. ## Server Requirements @@ -84,10 +84,10 @@ PHP version 7.2 or higher is required, with the following extensions installed: Additionally, make sure that the following extensions are enabled in your PHP: - json (enabled by default - don't turn it off) +- xml (enabled by default - don't turn it off) - [mbstring](http://php.net/manual/en/mbstring.installation.php) - [mysqlnd](http://php.net/manual/en/mysqlnd.install.php) -- xml (enabled by default - don't turn it off) ## Running CodeIgniter Tests -Information on running CodeIgniter test suite can be found in the [README.md](tests/README.md) file in the tests directory. +Information on running the CodeIgniter test suite can be found in the [README.md](tests/README.md) file in the tests directory. From 6f5bdf25c3035a4b1b3a8ec056a312c225b167a2 Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Thu, 16 May 2019 11:22:27 -0500 Subject: [PATCH 2/8] Rename contributing.md to CONTRIBUTING.md Capitalized the file name, for consistency. --- contributing.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename contributing.md => CONTRIBUTING.md (100%) diff --git a/contributing.md b/CONTRIBUTING.md similarity index 100% rename from contributing.md rename to CONTRIBUTING.md From e3667fabfc7ffe652ac8cf808f026d335323bc60 Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Thu, 16 May 2019 11:26:55 -0500 Subject: [PATCH 3/8] Update PULL_REQUEST_TEMPLATE.md Fixed typos and made a change for consistency --- PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 517473dd2d2d..db5aeb9eca37 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -Each pull request should address a single issue, and have a meaningful title. +Each pull request should address a single issue and have a meaningful title. **Description** Explain what you have changed, and why. @@ -15,8 +15,8 @@ Explain what you have changed, and why. **Notes** - Pull requests must be in English - If the PR solves an issue, reference it with a suitable verb and the issue number -(e.g. fixes 12345 -- Unsolicited PRs will be considered, but there is no guarantee of acceptance +(e.g. fixes 12345) +- Unsolicited pull requests will be considered, but there is no guarantee of acceptance - Pull requests should be from a feature branch in the contributor's fork of the repository to the develop branch of the project repository From 75805a18c29949a1d3528a57a6f64480173b1a92 Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Thu, 16 May 2019 14:26:29 -0500 Subject: [PATCH 4/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09dff38d437b..4a0f47f4d83e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,8 @@ ## Contributions -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). +We expect all contributions to conform to our [style guide](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/styleguide.rst), be commented (inside the PHP source files), +be documented (in the [user guide](https://codeigniter4.github.io/userguide/)), and unit tested (in the [test folder](https://github.com/codeigniter4/CodeIgniter4/tree/develop/tests)). There is a [Contributing to CodeIgniter](./contributing/README.rst) section in the repository which describes the contribution process; this page is an overview. ## Issues From c52d0ecb5c9035075c039a86be1bef2d1005b98c Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Thu, 16 May 2019 14:32:36 -0500 Subject: [PATCH 5/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a0f47f4d83e..36f68ec547cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,13 +9,13 @@ There is a [Contributing to CodeIgniter](./contributing/README.rst) section in t ## Issues -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: +Issues are a quick way to point out a bug. If you find a bug or documentation error in CodeIgniter then please make sure that: -1. There is not already an open Issue -2. The issue has already been fixed (check the develop branch, or look for closed Issues) -3. Is it something really obvious that you can fix yourself? +1. There is not already an open [Issue](https://github.com/codeigniter4/CodeIgniter4/issues) +2. The Issue has not already been fixed (check the develop branch or look for [closed Issues](https://github.com/codeigniter4/CodeIgniter4/issues?q=is%3Aissue+is%3Aclosed)) +3. It's not something really obvious that you can fix yourself -Reporting issues is helpful but an even [better approach](./contributing/workflow.rst) 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. +Reporting Issues is helpful, but an even [better approach](./contributing/workflow.rst) is to send a Pull Request, which is done by ["Forking"](https://help.github.com/en/articles/fork-a-repo) the main repository and making a [commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) to your own copy of the project. This will require you to use the version control system called [Git](https://git-scm.com/). ## Guidelines From 0f200c5f448779f0037394764a4511badcc26241 Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Thu, 16 May 2019 15:10:39 -0500 Subject: [PATCH 6/8] Update CONTRIBUTING.md Numerous updates were made to the CONTRIBUTING.md file in order to make the project more welcoming to new FOSS contributors. A number of inline links were added to facilitate learning of version control jargon. --- CONTRIBUTING.md | 49 ++++++++++++++++++++++++------------------------- 1 file changed, 24 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36f68ec547cb..667e438e77ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,65 +15,64 @@ Issues are a quick way to point out a bug. If you find a bug or documentation er 2. The Issue has not already been fixed (check the develop branch or look for [closed Issues](https://github.com/codeigniter4/CodeIgniter4/issues?q=is%3Aissue+is%3Aclosed)) 3. It's not something really obvious that you can fix yourself -Reporting Issues is helpful, but an even [better approach](./contributing/workflow.rst) is to send a Pull Request, which is done by ["Forking"](https://help.github.com/en/articles/fork-a-repo) the main repository and making a [commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) to your own copy of the project. This will require you to use the version control system called [Git](https://git-scm.com/). +Reporting Issues is helpful, but an even [better approach](./contributing/workflow.rst) is to send a [Pull Request](https://help.github.com/en/articles/creating-a-pull-request), which is done by [Forking](https://help.github.com/en/articles/fork-a-repo) the main repository and making a [Commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) to your own copy of the project. This will require you to use the version control system called [Git](https://git-scm.com/). ## Guidelines -Before we look into how, here are the guidelines. If your Pull Requests fail -to pass these guidelines it will be declined and you will need to re-submit +Before we look into how to contribute to CodeIgniter4, here are some guidelines. If your Pull Requests fail +to pass these guidelines, they will be declined, and you will need to re-submit when you’ve made the changes. This might sound a bit tough, but it is required -for us to maintain quality of the code-base. +for us to maintain quality of the codebase. ### PHP Style All code must meet the [Style Guide](./contributing/styleguide.rst). -This makes certain that all code is the same format as the existing code and means it will be as readable as possible. +This makes certain that all submitted code is of the same format as the existing code and ensures that the codebase will be as readable as possible. ### Documentation -If you change anything that requires a change to documentation then you will need to add it. New classes, methods, parameters, changing default values, etc are all things that will require a change to documentation. The change-log must also be updated for every change. Also PHPDoc blocks must be maintained. +If you change anything that requires a change to documentation, then you will need to add to the documentation. New classes, methods, parameters, changing default values, etc. are all changes that require a change to documentation. Also, the [changelog](https://codeigniter4.github.io/CodeIgniter4/changelogs/index.html) must be updated for every change, and [PHPDoc](https://github.com/codeigniter4/CodeIgniter4/blob/develop/phpdoc.dist.xml) blocks must be maintained. ### Compatibility -CodeIgniter4 requires PHP 7.2. +CodeIgniter4 requires [PHP 7.2](https://php.net/releases/7_2_0.php). ### Branching -CodeIgniter4 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 -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. +CodeIgniter4 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 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 the "master" branch to create a new version, without worrying about other features holding it up. For this reason, all commits need to be made to the "develop" branch, and any sent to the "master" branch 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. +**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. ### Signing -You must [GPG-sign](./contributing/signing.rst) your work, certifying that you either wrote the work or otherwise have the right to pass it on to an open source project. This is *not* just a "signed-off-by" commit, but instead a digitally signed one. +You must [GPG-sign](./contributing/signing.rst) your work, certifying that you either wrote the work or otherwise have the right to pass it on to an open source project. This is *not* just a "signed-off-by" commit, but instead, a digitally signed one. ## How-to Guide The best way to contribute is to fork the CodeIgniter4 repository, and "clone" that 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 CodeIgniter4 repo -3. Fork it (to your Github account) -4. Clone your CodeIgniter repo: git@github.com:\/CodeIgniter4.git -5. Create a new branch in your project for each set of changes you want to make. -6. Fix existing bugs on the Issue tracker after taking a look to see nobody else is working on them. -7. Commit the changed files in your contribution branch -8. Push your contribution branch to your fork -9. Send a pull request [http://help.github.com/send-pull-requests/](http://help.github.com/send-pull-requests/) +1. Set up Git ([Windows](https://git-scm.com/download/win), [Mac](https://git-scm.com/download/mac), & [Linux](https://git-scm.com/download/linux)). +2. Go to the [CodeIgniter4 repository](https://github.com/codeigniter4/CodeIgniter4). +3. [Fork](https://help.github.com/en/articles/fork-a-repo) it (to your Github account). +4. [Clone](https://help.github.com/en/articles/cloning-a-repository) your CodeIgniter repository: `git@github.com:\/CodeIgniter4.git` +5. Create a new [branch](https://help.github.com/en/articles/about-branches) in your project for each set of changes you want to make. +6. Fix existing bugs on the [Issue tracker](https://github.com/codeigniter4/CodeIgniter4/issues) after confirming that no one else is working on them. +7. [Commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) the changed files in your contribution branch. +8. [Push](https://help.github.com/en/articles/pushing-to-a-remote) your contribution branch to your fork. +9. Send a [pull request](http://help.github.com/send-pull-requests/). -The codebase maintainers 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. +The codebase maintainers will now be alerted to the submission and someone from the team will respond. If your change fails to meet the guidelines, it will be rejected or feedback will be provided to help you improve it. -Once the maintainer handling your pull request is happy with it they will merge it into develop and your patch will be part of the next release. +Once the maintainer handling your pull request is satisfied with it they will approve the pull request and merge it into the "develop" branch; your patch will now be part of the next release! ### Keeping your fork up-to-date -Unlike systems like Subversion, Git can have multiple remotes. A remote is the name for a URL of a Git repository. By default your fork will have a remote named "origin" which points to your fork, but you can add another remote named "codeigniter" which points to `git://github.com/codeigniter4/CodeIgniter4.git`. This is a read-only remote but you can pull from this develop branch to update your own. +Unlike systems like Subversion, Git can have multiple remotes. A remote is the name for the URL of a Git repository. By default, your fork will have a remote named "origin", which points to your fork, but you can add another remote named "codeigniter", which points to `git://github.com/codeigniter4/CodeIgniter4.git`. This is a read-only remote, but you can pull from this develop branch to update your own. -If you are using command-line you can do the following: +If you are using the command-line, you can do the following to update your fork to the latest changes: 1. `git remote add codeigniter git://github.com/codeigniter4/CodeIgniter4.git` 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. +Your fork is now up to date. This should be done regularly and, at the least, before you submit a pull request. From 4cadfe0644dad997da4666bbc794896b3e0044bb Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Fri, 17 May 2019 11:10:04 -0500 Subject: [PATCH 7/8] Update README.md Removed out-of-date reference to "phase 2". --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2e568971a4f9..076ac108b237 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ to optional packages, with their own repository. ## Contributing -We **are** accepting contributions from the community, specifically those identified as part of phase 2. +We **are** accepting contributions from the community!. We will try to manage the process somewhat, by adding a ["help wanted" label](https://github.com/codeigniter4/CodeIgniter4/labels/help%20wanted) to those that we are specifically interested in at any point in time. Join the discussion for those issues and let us know From 1a72a7ec210684cc535b00f30ad190b3edc27283 Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Fri, 17 May 2019 11:11:14 -0500 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 076ac108b237..47fa070ea963 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ to optional packages, with their own repository. ## Contributing -We **are** accepting contributions from the community!. +We **are** accepting contributions from the community! We will try to manage the process somewhat, by adding a ["help wanted" label](https://github.com/codeigniter4/CodeIgniter4/labels/help%20wanted) to those that we are specifically interested in at any point in time. Join the discussion for those issues and let us know