docs(readme): document source-code locations and build tools for the bundled editor - #101
Open
erseco wants to merge 2 commits into
Open
docs(readme): document source-code locations and build tools for the bundled editor#101erseco wants to merge 2 commits into
erseco wants to merge 2 commits into
Conversation
…bundled editor WordPress.org's detailed plugin guideline 4 (human-readable code) accepts minified/compiled code when the readme links the development location and its build tools. The plugin bundles the compiled eXeLearning editor (dist/static: minified bundles, compiled stylesheets, compressed data files), but readme.txt only linked this repository. Add a Source Code section stating that the plugin's own PHP/JS ship as readable source, pointing to https://github.com/exelearning/exelearning for the editor's source and build (make build-static), and noting that each release records the bundled editor version (.editor-version) and exact source commit (dist/static/.build-commit) — both files ship in the release package. Also documents how release ZIPs are assembled (make package / wp dist-archive).
Contributor
Test in WordPress PlaygroundTest the plugin with the code from this branch:
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #101 +/- ##
=========================================
Coverage 96.87% 96.87%
Complexity 864 864
=========================================
Files 39 39
Lines 4323 4323
=========================================
Hits 4188 4188
Misses 135 135
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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
WordPress.org's detailed plugin guideline 4 requires public, maintained access to the source code and build tools behind any minified/compiled code — satisfied either by shipping the sources or by "a link in the readme to the development location".
This plugin bundles the compiled eXeLearning editor (
dist/static: minified JavaScript bundles, compiled stylesheets and compressed data files), butreadme.txtonly linked this repository — not the editor's source. This is one of the compliance items for the WordPress.org submission tracked in exelearning/exelearning#1542, and complements the size-reduction work in exelearning/exelearning#2260 (which relies on this link for its dist-side minification of first-party editor code).Changes
readme.txtgains a== Source Code ==section that:make build-static, Bun,scripts/build-static-bundle.ts), and describes the compressed data files (*.json.zst/*.json.gzcurricular datasets and editor data, decoded in the browser by the bundledfzstdlibrary);.editor-version(bundled editor version) anddist/static/.build-commit(exact source commit) — both verified present in the v4.0.3 release package and not excluded by.distignore;make package→make build-editor+wp dist-archive).A changelog bullet is added under the unreleased
0.0.0block (version placeholders are rewritten bymake package, which this change does not touch).Notes for review
Makefilewritesdist/static/.build-commitduringbuild-editorand stampsStable tagat package time;.distignoreshipsdist/staticverbatim.== Source Code ==as a custom section, which is the form the Plugin Review Team recognizes for guideline-4 compliance.