Conversation
…3.1, v0.3.2, v0.3.3, and v0.4.0
ArchILLtect
added
documentation
✅ Deploy Preview for app-sameboat ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR documents planning and issue templates for Week 5 frontend development, focusing on implementing a Stories feature (feed, create, spoiler shields) and minimal profile editing capabilities. The changes are documentation-only, preparing the development roadmap for the next sprint iteration.
- Adds comprehensive Week 5 frontend planning documents with API contracts, component specifications, and acceptance criteria
- Creates 13 ready-to-copy GitHub issue templates covering Stories implementation, routing, testing, and profile editing
- Updates release milestones in issue templates from 0.2.0 to v0.3.1-v0.4.0 reflecting current project versioning
- Documents completed Week 4 achievements (v0.3.0 release) and Week 3 retrospectives
- Adds a future issues backlog for post-MVP features including E2E testing and automation improvements
Reviewed Changes
Copilot reviewed 12 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/weekly-reports/week-5/week-5-plan-frontend-draft.md | Detailed Week 5 Stories MVP implementation plan with API contracts, component specs, and testing guidance |
| docs/weekly-reports/week-5-issues.md | 13 copy-paste ready GitHub issue templates for Stories features, tests, and profile editing |
| docs/weekly-reports/week-5-frontend-plan.md | Week 5 plan with architecture overview, checklist, API contracts, and acceptance criteria |
| docs/weekly-reports/week-4/week-4-plan.md | Week 4 retrospective documenting auth flow, session persistence, and completed deliverables |
| docs/weekly-reports/week-4/week-4-plan-frontend.md | Week 4 implementation details with v0.3.0 release status update |
| docs/weekly-reports/week-3/week-3-plan.md | Week 3 plan covering auth UX foundations and session management |
| docs/weekly-reports/week-3/week-3-plan-checklist.md | Detailed Week 3 progress checklist with metrics and completion tracking |
| docs/weekly-reports/week-3/Week-3-kick-off.md | Brief Week 3 kickoff notes with terminal commands |
| docs/weekly-reports/post-mvp/future-issues.md | Backlog of pre-scoped issues for visibility refresh E2E tests and release automation |
| docs/weekly-reports/exit-reports/week-4-exit-report.md | Week 4 exit report summarizing completed work and metrics |
| docs/status/done-to-date.md | Updated progress snapshot through v0.3.0 with Week 5 focus |
| README.md | Added Changelog 0.3.0 badge linking to specific CHANGELOG section |
| .github/copilot-instructions.md | Minor correction removing hash symbol from root element reference |
| .github/ISSUE_TEMPLATE/tooling.yml | Updated target release options to v0.3.1-v0.4.0 |
| .github/ISSUE_TEMPLATE/test.yml | Updated target release options to v0.3.1-v0.4.0 |
| .github/ISSUE_TEMPLATE/feature.yml | Updated target release options to v0.3.1-v0.4.0 |
Corrected spelling of 'Estimati on' to 'Estimation'. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| ## 🌐 API Layer Additions (`src/lib/api.ts` or a nearby `stories.ts`) | ||
| Expose thin helpers (all `credentials: 'include'`): | ||
| ```ts | ||
| type Story = { id: string; authorId: string; content: string; createdAt: string; updatedAt?: string | null }; |
There was a problem hiding this comment.
Type definition inconsistency: this minimal Story type lacks title and triggers fields that are present in week-5-frontend-plan.md lines 51-62. This will cause type mismatches when implementing the components described in lines 54-68 which expect these fields.
Character limit discrepancy: this document specifies 1-1000 chars for story content, but line 73 in the same document and line 93 in week-5-frontend-plan.md specify a minimum of 50 chars. The minimum constraint should be consistent across all Week 5 planning documents. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
API contract mismatch: this endpoint accepts only content but the implementation guidance in lines 66-67 and week-5-frontend-plan.md line 66 shows POST /api/stories accepting { title, content, triggers }. The backend contract should match the actual expected request body format.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 12 out of 16 changed files in this pull request and generated 3 comments.
Comments suppressed due to low confidence (1)
docs/weekly-reports/week-5/week-5-plan-frontend-draft.md:1
- The API contract shows
POST /api/storiesaccepting atitlefield, but line 74 in the same document defines theStorytype with onlycontent(notitlefield). This inconsistency between the endpoint contract and type definition needs to be resolved.
# SameBoat – Week 5 Frontend Copilot Query (Stories MVP)
| @@ -1,5 +1,6 @@ | |||
| [](https://github.com/sameboat-platform/frontend/actions/workflows/frontend-ci.yml) | |||
| [](https://github.com/sameboat-platform/frontend/releases) | |||
| [](CHANGELOG.md#030---2025-10-29) | |||
There was a problem hiding this comment.
The changelog anchor link is incorrect. GitHub generates anchors by converting ## [0.3.0] - 2025-10-29 to lowercase and replacing brackets and spaces with hyphens. The correct anchor should be #030---2025-10-29 not #030---2025-10-29. Based on GitHub's slug generation rules, the correct format is #030---2025-10-29.
| Assumptions | ||
| - Backend provides cookie‑session auth with `/api/me`, `/api/auth/*` (as in Week 4). | ||
| - Stories API exists or will be scaffolded to match the contracts below; if not ready, mock via dev routes. | ||
| - Use Chakra UI and strict TypeScript; no new heavy libs (no React Query). Keep fetch wrapper `api.ts`. |
There was a problem hiding this comment.
The Week 5 plan references using 'Chakra UI' but according to the coding guidelines and existing architecture, the project uses basic CSS imports alongside React components. This documentation should clarify whether Chakra UI is actually being adopted for Week 5 or if this is a documentation error that should reference the existing CSS approach mentioned in the custom guidelines.
| - Use Chakra UI and strict TypeScript; no new heavy libs (no React Query). Keep fetch wrapper `api.ts`. | |
| - Use basic CSS imports alongside React components (per guidelines) and strict TypeScript; no new heavy libs (no React Query). Keep fetch wrapper `api.ts`. |
| id: string; | ||
| authorId: string; | ||
| authorName?: string; | ||
| title: string; |
There was a problem hiding this comment.
The Story type definition includes a title field which is inconsistent with line 9 of week-5-plan-frontend-draft.md that describes creating 'a text story (50–1000 chars)' with no mention of a title. The two planning documents should have consistent field definitions for the Story entity.
This pull request documents the release of frontend v0.3.0, closes out the Week 4 milestone, and sets up planning and issue templates for future work (v0.3.1 and v0.4.0). It adds comprehensive release notes, updates badges and status docs, and introduces detailed implementation plans and issue drafts for upcoming features, including the Stories feed and profile editing. The changes also improve issue templates to support new release targets.
Release documentation and planning updates:
docs/status/done-to-date.mdto reflect work completed through v0.3.0 and backend status, with a snapshot of shipped features and Week 5 focus.Issue and workflow improvements:
feature.yml,test.yml,tooling.yml) to support new target releases: v0.3.1, v0.3.2, v0.3.3, v0.4.0, and "Future". [1] [2] [3]Documentation and badge updates:
README.mdfor easier navigation to release notes.Minor corrections:
.github/copilot-instructions.mdregarding the root element in the SPA description.