docs: add ARCHITECTURE, ROADMAP, CITATION, FUNDING, editorconfig#62
Open
kingchenc wants to merge 1 commit into
Open
docs: add ARCHITECTURE, ROADMAP, CITATION, FUNDING, editorconfig#62kingchenc wants to merge 1 commit into
kingchenc wants to merge 1 commit into
Conversation
Five governance + onboarding files that collectively close the "no high-level documentation outside of README" gap. - ARCHITECTURE.md: workspace layout, Indicator trait contract, per-indicator file conventions, numerical-stability notes, cross-crate flow diagram, navigation cheatsheet, deliberate non-goals, performance characteristics, stability commitments. - ROADMAP.md: north star, 0.3 / 0.4 / 0.5 release windows, indicator-wishlist intake rules, explicit non-goals, versioning policy. - CITATION.cff: GitHub-renders as "Cite this repository" button; enables academic adoption. - .github/FUNDING.yml: surfaces Sponsor button on the repo page. - .editorconfig: normalises indent/EOL across IDEs (Rust/Python 4 spaces, JS/TS/JSON/YAML/MD 2 spaces, Makefile tabs). Touches no Rust source, no CI workflows, no behaviour. Additive only. URLs in ROADMAP/CITATION already reference the post-transfer `wickra-lib/wickra` org so the files stay valid once the org migration in PR #59 lands; merge this PR only after #59 to keep main consistent.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This was referenced May 27, 2026
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
1 participant
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
Adds five governance + onboarding files that close the no high-level documentation outside of README gap. Touches no Rust source, no CI workflows, no behaviour. Additive only.
ARCHITECTURE.mdROADMAP.mdCITATION.cff.github/FUNDING.yml.editorconfigWhy
Filling out Section A of the improvements TODO (governance polish). Closes part of Section A.2 and E.2/E.3/E.4/E.15/E.16 from the project analysis.
Merge order
Already-open companion PRs are #59 (org migration), #60 (family-api), #61 (release 0.2.8). This PR is independent of all three — no shared files, no conflicts. Recommended merge order remains #59 → #60 → #61 → this PR after the org transfer on GitHub side.
URLs in
ROADMAP.mdandCITATION.cffreference the post-transferwickra-lib/wickraorg so files stay valid once #59 lands. They will 404 only during the brief window between this PR's merge and the GitHub-side org transfer.CI expectation
29 standard checks (sync-metadata.yml from #59 not present here yet). All must be green.