docs: add project roadmap and architecture decision records (closes #85)#86
Open
lawie1425 wants to merge 1 commit intobos-com:mainfrom
Open
docs: add project roadmap and architecture decision records (closes #85)#86lawie1425 wants to merge 1 commit intobos-com:mainfrom
lawie1425 wants to merge 1 commit intobos-com:mainfrom
Conversation
Closes bos-com#85 - Add ROADMAP.md with four development phases - Create ADR template in docs/adr/ - Add ADR-001: MIT License Selection rationale - Add ADR-002: Documentation-First Development approach - Link roadmap to BOSC sub-projects (GreenCode, OpenCare-Core, LifeLine-ICT)
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 a project roadmap and establishes an Architecture Decision Record (ADR) framework for BOS.
Closes #85
Changes
New Files
docs/ROADMAP.md— Four-phase development roadmap:docs/adr/template.md— Reusable ADR template with Status, Context, Decision, Consequences sectionsdocs/adr/001-mit-license.md— Documents the rationale for choosing MIT License, including trade-offs vs copyleft and Apache 2.0docs/adr/002-documentation-first.md— Documents the documentation-first development approach adopted by BOSC, explaining why docs come before codeMotivation
Open-source projects without clear roadmaps struggle to attract contributors because people don't know what to work on. ADRs preserve institutional knowledge about why decisions were made, which is critical for a student-driven project with annual contributor turnover.
Checklist