Matsubaa/FedDIY
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Update documentation to clarify Nix usage and enhance onboarding for non-Nix contributors

Browse Source
This commit is contained in:
Kyle J. Turpin
2026-05-23 18:17:47 -05:00
parent 94c7cadcd7
commit 2ecab4db12
4 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ROADMAP.md
+2 -1
View File
@@ -10,7 +10,7 @@ Build a federated DIY project-hosting platform in Rust, inspired by the utility
Goals:
- Stabilize development environment and reproducible tooling.
- Stabilize development environment and reproducible tooling, while keeping the contributor path usable for people who do not use Nix.
- Define domain language and baseline architecture docs.
- Establish quality process (TDD/BDD + GitHub Flow).
- Clarify the core-plus-extension project contract before implementation.
@@ -21,6 +21,7 @@ Exit criteria:
- Agreed glossary and architecture baseline.
- Documented contribution and branch workflow.
- CI skeleton in place for formatting, linting, and tests.
- Documented onboarding path for non-Nix contributors using standard Rust toolchain commands.
- ADR for project revision lifecycle (draft/publish/supersede).
- ADR for composable extension mechanism (shape, namespacing, discovery).
- ADR for persistence layer architecture (PostgreSQL as primary target; repository abstraction pattern; query library selection; SQLite future-option strategy).