fix: quick wins from technical review (bugs, CI, Node, docs)#31
Merged
Conversation
- ProjectFrontmatter.tsx: fix 'aira-label' typo → 'aria-label' - ProjectFrontmatter.tsx: add key prop to span elements in reduce - SidebarToggle.tsx: swap ARIA labels (X → Hide, Menu → Show)
Runs on push/PR to main: npm run compile + npm run prod:build
- package.json engines.node: >=14 → >=18 (Remix 1.19 requirement) - Add .nvmrc pinned to Node 18 - Update release.yml actions to v4
Development setup, available scripts, project structure, commit conventions, and release process (Changesets).
There was a problem hiding this comment.
Pull request overview
This PR implements low-risk improvements identified in a technical review, focusing on bug fixes, CI automation, Node.js version alignment, and developer documentation. The changes enhance accessibility, remove React warnings, establish automated quality checks, and improve the developer experience.
Changes:
- Fixed accessibility bugs in React components (typo in aria-label, swapped ARIA labels, missing key props)
- Added CI pipeline to run type-checking and production builds on every push/PR to main
- Bumped Node.js requirement from >=14 to >=18 to align with Remix 1.19, added .nvmrc, and updated GitHub Actions versions
- Added comprehensive CONTRIBUTING.md with development setup, scripts, structure, and conventions
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Bumped engines.node from >=14 to >=18 to match Remix 1.19 requirements |
| app/components/toolbar/SidebarToggle.tsx | Fixed swapped ARIA labels - X icon now correctly says "Hide", Menu icon says "Show" |
| app/components/ProjectFrontmatter.tsx | Fixed typo aira-label → aria-label and added key prop to span elements in reduce with proper fallback chain |
| CONTRIBUTING.md | Added comprehensive contributor guide covering setup, scripts, structure, commit conventions, and releases |
| .nvmrc | Added Node version file pinned to 18 for consistent development environment |
| .github/workflows/release.yml | Updated actions/checkout and actions/setup-node from v3 to v4 |
| .github/workflows/ci.yml | Added new CI workflow running typecheck and production build on push/PR to main |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Quick Wins from Technical Review
Implements 4 low-risk items identified in the technical review (REVIEW.md Parts 3 & 4).
Bug Fixes
ProjectFrontmatter.tsx: Fixaira-labeltypo →aria-label(screen readers could not find the authors section)ProjectFrontmatter.tsx: Addkeyprop to<span>elements in.reduce()(React warning in dev)SidebarToggle.tsx: Swap ARIA labels — X icon now says "Hide table of contents", Menu icon says "Show table of contents"CI Pipeline
.github/workflows/ci.yml— runsnpm run compile(typecheck) +npm run prod:buildon every push/PR tomainNode Engine
engines.nodefrom>=14to>=18(Remix 1.19 requires Node 18+).nvmrcpinned to18release.ymlactions from v3 → v4Documentation
CONTRIBUTING.mdwith development setup, scripts, project structure, commit conventions, and release process