How to Contribute
Relevant source files
The following files were used as context for generating this wiki page. Note: The project repository zhgabor/ci4_userguide is a minimal fork containing only a README.md file. No other relevant source files exist within this repository to fulfill the 5-file minimum requirement. All information is derived from the single available file.
This document outlines the contribution process for the CodeIgniter 4 User Guide. It is important to note that this specific repository (ci4_userguide) is a read-only mirror used solely for publishing the user guide. Direct contributions, such as pull requests, are not accepted here.
The primary purpose of this guide is to direct potential contributors to the correct channels for submitting changes, reporting issues, or suggesting new features for the CodeIgniter 4 project and its documentation. All development and documentation work occurs in the main CodeIgniter 4 repository.
Sources: README.md:7-9, README.md:11-13
Contribution Workflow
Contributions to the user guide are not made directly to this repository. Instead, they follow a workflow that directs users to the central development repository or the official community forums, depending on the nature of the contribution.
Sources: README.md:7-9
Contribution Process Flow
The following diagram illustrates the decision-making process for a potential contributor.
This diagram shows that any identified issues or ideas originating from this user guide repository must be channeled to external locations: the main codeigniter4/codeigniter4 repository for fixes or the official forums for discussion.
Sources: README.md:11-17
Contribution Channels
There are two primary channels for contributing, depending on the type of contribution you wish to make.
| Contribution Type | Target Channel | Description |
|---|---|---|
| Correcting Problems | Main codeigniter4/codeigniter4 Repository | For any issues found within the user guide, such as typos, errors, or outdated information. A pull request should be submitted there. |
| Missing/Unclear Features | Official CodeIgniter Forum | For suggestions about features that are missing from the documentation or sections that are unclear. |
Sources: README.md:11-17
Correcting User Guide Content
If you find a problem within the user guide, the correction must be submitted as a pull request to the main development repository. This repository is located at `https://github.com/codeigniter4/codeigniter4%60. This process ensures that documentation changes are tracked alongside framework code changes.
Sources: README.md:11-13
Discussing Features and Clarity
If you believe features are missing from the documentation or that existing topics are unclear, these should be brought up for discussion on the official CodeIgniter forums. This allows the community and development team to discuss the best approach before any changes are made. The forums can be found at https://forum.codeigniter.com/index.php.
Sources: README.md:15-17
Summary
This repository serves as a published version of the CodeIgniter 4 User Guide and does not accept direct contributions. All efforts to improve the documentation must be directed to the appropriate external channels: pull requests for corrections to the codeigniter4/codeigniter4 repository and discussions on the official forums for feature requests or clarity improvements.
Sources: README.md:7-17