Restructure sample apps process into Scope / Build / Document phases#155
Open
fryorcraken wants to merge 9 commits into
Open
Restructure sample apps process into Scope / Build / Document phases#155fryorcraken wants to merge 9 commits into
fryorcraken wants to merge 9 commits into
Conversation
Reorganise the Sample Apps page around the full lifecycle: - Scope: functional scope (FURPS+ & user stories) and ADRs, both requiring team review (PR), plus dependencies. - Build: publish the module to the Eco Dev Eng module repo (TBD). - Document: doc-packet to the doc team (install/use + what the code demonstrates), with team review of the docs expected. Slim the Sample App Scoping issue template down to a light checklist that links to the page, moving the rationale onto the page where it is more likely to be read. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- FURPS.md -> SCOPE.md since functional scope may be FURPS+ or user stories. - State the three phases apply to one version; a sample app may have several. - Note dependencies are written once and reused in the doc-packet. - Add a "Definition of done" checklist defining when a version is shipped. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Strip all em-dashes from the page and issue template (commas/colons). - Refer to SCOPE.md rather than FURPS+ when describing the behaviour doc, since a version may use user stories instead. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Link the Document phase and DoD to the existing doc-packet issue template in logos-co/logos-docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
One scope issue (Sample App Scoping template) and one build/publish/doc issue per version, replacing the milestone-based tracking. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
ADRs and dependencies emerge from building/exploration, so they belong with Build rather than Scope: - Page: Scope now holds only the functional scope; ADRs and Dependencies move under Build. DoD and Tracking updated accordingly. - Scoping template: drop ADRs/Dependencies, note they live on the build issue. - Add sample-app-build.md issue template covering build, publish, ADRs, dependencies and the doc-packet handoff. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Remove accidentally committed .claude/settings.local.json and ignore the directory. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
fryorcraken
changed the title
weboko
reviewed
Jun 19, 2026
|
|
||
| ## Definition of Done | ||
|
|
||
| - [ ] **Build**: sample app built against scope, in a public repo with the right licensing. |
Collaborator
There was a problem hiding this comment.
shall we define it as CI step that would build a basecamp module?
Collaborator
Author
There was a problem hiding this comment.
yes but the software is not ready, see https://discord.com/channels/973324189794697286/1516664571451146391/1517422367469736037
weboko
reviewed
Jun 19, 2026
|
|
||
| Architecture Decision Records documenting **why** we built it this way, conveying how to use the Logos stack. Lives in an `ADR.md` alongside the sample app. | ||
|
|
||
| The `SCOPE.md` documents behaviour; ADRs document the reasoning behind design and protocol choices. As we build sample apps, we make decisions to use Logos components (delivery, storage, etc.) in specific ways. We document those decisions so that developers using sample apps as inspiration or examples understand why we did so. For example: |
Collaborator
There was a problem hiding this comment.
what SCOPE behavior would look like? i.e is it similar to DOGFOODING.md?
Collaborator
Author
There was a problem hiding this comment.
That's the FURPS, or user stories for those who don't like FURPS. see line 21
weboko
approved these changes
Jun 19, 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
2 participants
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.
Updates the Sample Apps expectations and moves the per-deliverable rationale onto the page, where it is more likely to be read than in issue-template comments.
What changed
A sample app may have several versions. Each version moves through three phases: Scope → Build → Document, with team-review expectations per phase.
Scope (PR, team reviewed)
SCOPE.md(renamed fromFURPS.md, since a version may use user stories instead).Build (public repo, right licensing)
ADR.md). Team reviewed.README.mdsection).ADRs and dependencies emerge from building/exploration, so they belong with Build rather than Scope.
Document
logos-co/logos-docs: how to install (via the module repo) and use, plus what the code demonstrates (drawing on Dependencies). GUI doc-packets need no screenshots and can be light. Docs must be team reviewed.Definition of done
Tracking
Issue templates
sample-app-scope.md: slimmed to the functional-scope checklist, links to the page, notes ADRs/dependencies live on the build issue.sample-app-build.md: new template covering build, publish, ADRs, dependencies, and the doc-packet handoff.Housekeeping
.claude/local settings and added it to.gitignore.🤖 Generated with Claude Code