Repository navigation
docs: record that the stable app ships 0.x libraries of a draft ecosystem - #94
Merged
Merged
Conversation
…stem Criterion 16 of the Standard for Public Code asks that a version ready to use depends only on versions ready to use. Every version from 1.0.0 on is declared ready, and it ships four dependencies before their own 1.0.0. vendor-code.md gave each one a reason, but nothing recorded the project's choice to ship a stable app on them, and the assessment listed the MUST as partial with no path, as if it were work waiting. Decision 14 records it: Solid Memo is stable within an ecosystem that is not yet at 1.0, the four stay with their reasons, and the MUST is a gap until they reach 1.0.0 or a ready replacement exists. Criterion 16, "Gaps that remain" and vendor-code.md point to it. Each row of vendor-code.md now says what that package's 0.x means: process is final at 0.11 by its maintainer's choice, and the two Zazuko packages break only in a 0.x minor, which a caret range keeps out, so the risk is slow upkeep. ALLOWED, vendor-code.md and the assessment called rdf-validate-shacl the only SHACL engine for RDF/JS, with no replacement. shacl-engine has been at 1.0.0 since 2024, but brings in packages before 1.0.0 of its own and a SPARQL engine the app does not need, so they now say so. Closes: #89
1 task
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.
What and why
Criterion 16 of the Standard for Public Code says that a version ready to use depends only on versions ready to use. Every version from 1.0.0 on is declared ready, and each one ships four dependencies before their own 1.0.0. vendor-code.md gives each of them a reason. But nothing recorded the project's choice to ship a stable app on a pre-1.0 ecosystem. The assessment also listed the MUST as partial with no path, as if it were work waiting to be done.
This pull request records that choice and makes the docs say the same:
processis final at 0.11 by its maintainer's choice (Add missing 'platform' field defunctzombie/node-process#82).rdf-validate-shaclandrdf-validate-datatypebreak only in a 0.x minor, which^keeps out. The risk is slow upkeep (Version Packages zazuko/rdf-validate-shacl#171, "too much recursion" when validating large xsd:base64Binary zazuko/rdf-validate-datatype#30), and theShapeEngineinterface and the shacl tests contain it.ALLOWEDinscripts/checkDependencies.ts, vendor-code.md and the assessment no longer say thatrdf-validate-shaclis "the only SHACL engine for RDF/JS" or "has no replacement".shacl-engine1.x exists, but it brings in packages before 1.0.0 of its own (rdf-validation0.1,process0.11) and a SPARQL engine the app does not need.npm run check:dependenciesis unchanged: it still allows only these four.defunctzombieis added to the cspell words for the link.Refs: #89
Checklist
npm run checkpasses (lint, Markdown and spelling included),npm run lint:reusetoo if a file was added, andnpm run crosschecktoo ifns/ordecks/changed. (lint:reuseandcrosscheckn/a: no file was added, andns/anddecks/are unchanged)ALLOWEDchanged, and the existing tests cover them)docs/is listed in docs/README.md.packages/ui/src/i18n/). (n/a: no UI message changed)ns/was agreed in an issue first; no publishedns/shapes/*/vN.ttlordecks/*/vN.ttlwas edited; generated files were regenerated, not edited. (n/a:ns/anddecks/are unchanged)!and aBREAKING CHANGE:footer).npm run check:breakingsees a line ofapi/that goes, but not a feature removed, nor a reader that reads less than before.npm run lint:reuse), or a new deck its line inREUSE.toml; third-party content is credited. (n/a: no file was added)npm run dev) and tried the change, and considered the user journeys. (n/a: only docs and the reason strings of a check script changed; the app is unchanged)type(scope): subject,!and aBREAKING CHANGE:footer if it breaks something), with an imperative subject and a body that explains why (CONTRIBUTING.md).