Skip to content

docs: fix and expand Development/Making Changes section in README#737

Merged
skjnldsv merged 1 commit intomasterfrom
jtr/docs-readme-dev-update
Apr 8, 2026
Merged

docs: fix and expand Development/Making Changes section in README#737
skjnldsv merged 1 commit intomasterfrom
jtr/docs-readme-dev-update

Conversation

@joshtrichards
Copy link
Copy Markdown
Member

This PR brings the dev docs more in line with the current codebase.

Changes:

  • Remove /lib/RecursiveDirectoryIteratorWithoutDate.php
  • Extract the Makefile into its own "Build system" subsection instead of listing it in multiple spots
  • Document how make index.php works (since it's a bit novel to the Updater)
  • Document how make updater.phar works
  • Add "Build configuration files" subsection
  • List Composer as an explicit build dependency
  • Expand the Testing section: name the test framework (Behat), list all available make test* targets, note where test data lives
  • Explain what check-same-code-base actually validates
  • Clarify that /lib/Version.php is gitignored, not just "not checked in"

Signed-off-by: Josh <josh.t.richards@gmail.com>
@skjnldsv skjnldsv merged commit 6db2f2b into master Apr 8, 2026
21 checks passed
@skjnldsv skjnldsv deleted the jtr/docs-readme-dev-update branch April 8, 2026 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants