Repository navigation
[TASK] Move the build documentation from README.md to CONTRIBUTING.md - #605
Merged
Merged
Conversation
README.md is the entry point for the users of the images. How the files of this repository are generated and how the images are built, checked and tested moves to CONTRIBUTING.md without a change of content; only the two references to the README become links. GitHub links the file on the pages for a new issue and a new pull request. README.md keeps the heading "Build process" with a link to the new file, so links to it still lead there. AGENTS.md lists CONTRIBUTING.md among the documentation, and docs/README.md links to it.
|
Kanti
marked this pull request as ready for review
November 11, 2026 07:20
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.mdis the entry point for the users of the images. Everything about generating the files of this repository and building, checking and testing the images moves to a newCONTRIBUTING.md. GitHub links that file on the pages for a new issue and a new pull request.Changes
CONTRIBUTING.md: the sections "File generation", "Building in CI", "Building and testing locally" and "PHP extension builds" from the README, one heading level up. The content is unchanged; only "the banner at the top of this README" and "the quick start above" become links to the README.README.md: the heading "Build process" stays with one sentence and a link toCONTRIBUTING.md, so links toREADME.md#build-processstill lead there.AGENTS.md:CONTRIBUTING.mdin the table of documentation files, the README row without "build process", and "the commands inCONTRIBUTING.md" in "When to update it".docs/README.md: the link fordockerfile-build-envgoes to "Building in CI" inCONTRIBUTING.md.Docs
CONTRIBUTING.mddiffof the removed README lines againstCONTRIBUTING.md: only the heading levels and the two links differREADME.md,CONTRIBUTING.md,AGENTS.md,docs/**/*.mdHow it was verified
docker/,.github/workflows/build.yamlor the banner changes, so "Validate Automation" is not affected