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 section in the repository which describes the contribution process; this page is an overview.
Note, we expect all code changes or bug-fixes to be accompanied by one or more tests added to our test suite to prove the code works. If pull requests are not accompanied by relevant tests, they will likely be closed. Since we are a team of volunteers, we don't have any more time to work on the framework than you do. Please make it as painless for your contributions to be included as possible. If you need help with getting tests running on your local machines, ask for help on the forums. We would be happy to help out.
The Open Source Guide is a good first read for those new to contributing to open source!
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:
- There is not already an open Issue
- The Issue has not already been fixed (check the develop branch or look for closed Issues)
- It's not something really obvious that you can fix 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 making a Commit to your own copy of the project. This will require you to use the version control system called Git.
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 the quality of the codebase.
All code must meet the Style Guide. 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.
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 must be updated for every change, and PHPDoc blocks must be maintained.
CodeIgniter4 requires PHP 7.2.
CodeIgniter4 uses the Git-Flow 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.
A reminder: please use separate branches for each of your PRs - it will make it easier for you to keep changes separate from each other and from whatever else you are doing with your repository!
You must GPG-sign 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.
We cannot, at all times, guarantee that all PHP code submitted on pull requests to be working well without actually running the code. For this reason, we make use of two static analysis tools, PHPStan and Rector to do the analysis for us.
These tools have already been integrated into our CI/CD workflow to minimize unannounced bugs. Pull requests are expected that their code will pass these two. In your local machine, you can manually run these tools so that you can fix whatever errors that pop up with your submission.
PHPStan is expected to scan the entire framework by running this command in your terminal:
vendor/bin/phpstan analyse
Rector, on the other hand, can be run on the specific files you modified or added:
vendor/bin/rector process --dry-run path/to/file
In general, any change that would disrupt existing uses of the framework is considered a "breaking change" and will not be favorably considered. A few specific examples to pay attention to:
- New classes/properties/constants in
systemare acceptable, but anything in theappdirectory that will be used insystemshould be backwards-compatible. - Any changes to non-private methods must be backwards-compatible with the original definition.
- Deleting non-private properties or methods without prior deprecation notices is frowned upon and will likely be closed.
- Deleting or renaming public classes and interfaces, as well as those not marked as
@internal, without prior deprecation notices or not providing fallback solutions will also not be favorably considered.
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".
- Set up Git (Windows, Mac, & Linux).
- Go to the CodeIgniter4 repository.
- Fork it (to your Github account).
- Clone your CodeIgniter repository:
[email protected]:\<your-name>/CodeIgniter4.git - Create a new branch in your project for each set of changes you want to make.
- Fix existing bugs on the Issue tracker after confirming that no one else is working on them.
- Commit the changed files in your contribution branch.
- Commit messages are expected to be descriptive of what you changed specifically. Commit messages like "Fixes #1234" would be asked by the reviewer to be revised.
- If there are intermediate commits that are not meaningful to the overall PR, such as "Fixed error on style guide", "Fixed phpstan error", "Fixing mistake in code", and other related commits, it is advised to squash your commits so that we can have a clean commit history.
- If you have touched PHP code, run static analysis.
- Run unit tests on the specific file you modified. If there are no existing tests yet, please create one.
- Make sure the tests pass to have a higher chance of merging.
- Push your contribution branch to your fork.
- Send a pull request.
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 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!
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 the command-line, you can do the following to update your fork to the latest changes:
git remote add codeigniter git://github.com/codeigniter4/CodeIgniter4.gitgit pull codeigniter developgit push origin develop
Your fork is now up to date. This should be done regularly and, at the least, before you submit a pull request.
If you wish to contribute to the system message translations, then fork and clone the translations repository separately from the codebase.
These are two independent repositories!