[codex] Document development plan and contributor workflow#986
Open
mimeding wants to merge 5 commits intoosaurus-ai:mainfrom
Open
[codex] Document development plan and contributor workflow#986mimeding wants to merge 5 commits intoosaurus-ai:mainfrom
mimeding wants to merge 5 commits intoosaurus-ai:mainfrom
Conversation
This was referenced Apr 30, 2026
Contributor
Author
|
Author-side cleanup complete; this PR is now ready for review. Verification:
This branch includes the same PR CI hardening and FluidAudio |
c2978b8 to
5a52a19
Compare
5a52a19 to
b16df38
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.
Business rationale
Osaurus is at its strongest when contributors can ship harness improvements without guessing which local gates, CI rules, or roadmap priorities matter. This PR makes the development plan and clean-PR workflow explicit so document fidelity, agents, plugins, privacy, and release work move through the same predictable review path.
Coding rationale
The plan lives in
docs/and links outward from contributor-facing entry points instead of being scattered across comments or PR descriptions. The CI-cleanliness rule is documented in Cursor rules, the PR template, and a small shell gate so future branches can fail before GitHub does. The workflow cache notes stay in CI/developer docs because they explain operational behavior without changing product code. The branch was rebased onto currentorigin/main, dropping stale stacked code that now belongs to already-green bug-fix PRs.What changed
docs/DEVELOPMENT_PLAN.mdwith phased priorities, near-term sprints, security/privacy backlog, file-I/O sequencing, and definitions of done.docs/CONTRIBUTING.md,docs/DEVELOPER_TOOLS.md,docs/FEATURES.md, andREADME.mdlinks around the clean local verification path..cursor/rules/pr-clean-ci.mdcand updated.cursor/rules/swift-build.mdcfor PR readiness expectations..github/pull_request_template.mdand.github/workflows/ci.ymlto make required checks and cold DerivedData behavior clearer.scripts/ci/check-pr-clean.shfor local branch/readiness checks.Validation
swift build --package-path Packages/OsaurusCoreswift build --package-path Packages/OsaurusCore -c releaseswift test --package-path Packages/OsaurusCoreshellcheck scripts/ci/check-pr-clean.shgit diff --check origin/main...HEADgit diff --checkNon-scope
Residual risks