Repository navigation
docs: add MIT licence and rewrite docs for public readers - #7
Merged
Merged
Conversation
jm-rivera
marked this pull request as ready for review
October 23, 2026 06:29
jm-rivera
force-pushed
the
docs/public-repo-docs
branch
from
October 26, 2026 07:32
ab90267 to
80ffbf4
Compare
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.
Rewrites the README for a public reader, adds a contributing guide and an MIT licence, and moves design notes into
docs/development.md.The repository had no LICENSE or CONTRIBUTING.
LICENSEis now MIT, copyright ONE Campaign.CONTRIBUTING.mdgives each package's CI commands (pytest, ruff, ty), the seventools/validate_*.pyvalidators andtools/tests, the registry mirror rule, the branch model and a changelog convention.README.mdreplaced one dense status paragraph per package with a table of distribution, import name and purpose, and kept the uv, pip and[tool.uv.sources]install instructions, checked against eachpyproject.toml. It drops references to a design document outside the repository and to planned freezes, and states the current fact that no package is on PyPI. The two schema families, the path-source dependency detail, and release and tag semantics move todocs/development.md.CONTRIBUTING.mdlinks the organisation code of conduct, security policy and support guide by absolute URL. Those links resolve once DevelopmentFinanceObservatory/.github#1 merges.Left for a follow-up:
schemas/spec/README.mdandtools/README.mddescribe a drift check and codegen that do not exist, and the localv0.1.0tag is not on origin, so the registry immutability check is skipped.Testing: mdformat passes on the three files, the seven validators run clean, and
tools/testspasses (53 tests). The package test suites were not run, since no code changed.