feat(plt-998): create coding best practices Next.js website#1
Open
kurodo3[bot] wants to merge 2 commits intodevfrom
Open
feat(plt-998): create coding best practices Next.js website#1kurodo3[bot] wants to merge 2 commits intodevfrom
kurodo3[bot] wants to merge 2 commits intodevfrom
Conversation
Implements a static Next.js 14 site covering six core engineering topics: Clean Code, SOLID Principles, Git Workflow, Testing, Code Review, and Performance. Each topic has a dedicated page with principles, descriptions, and good/bad code examples. Includes responsive CSS modules, a shared Navbar/Footer, a 404 page, and a Jest test suite (7 tests, all passing). Fixes: PLT-998 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
eywalker
requested changes
Mar 18, 2026
| @@ -0,0 +1,40 @@ | |||
| # Coding Best Practices | |||
There was a problem hiding this comment.
Include information about Nauticalab as can be found in https://nauticalab.org
eywalker
approved these changes
Mar 18, 2026
| @@ -0,0 +1,54 @@ | |||
| import { | |||
eywalker
requested changes
Mar 18, 2026
| expect(categories.length).toBeGreaterThan(0); | ||
| }); | ||
|
|
||
| it("every category has required fields", () => { |
Contributor
Author
There was a problem hiding this comment.
Good catch — added a 4-line comment above the test (commit f76ef68) explaining its purpose:
Guards against incomplete data entries in
practices.ts— ensures everyCategoryobject has all fields (slug,title,icon,description,color, and a non-emptyprinciplesarray) that the UI components depend on at runtime, so a missing field won't silently cause a broken page.
In short, TypeScript's structural typing still allows a field to be an empty string or undefined if it isn't caught at the data-entry level, so this test acts as a data-integrity guard for the practices.ts content file.
…test Add an inline comment explaining that the test guards against incomplete data entries in practices.ts, ensuring all UI-required fields are present at runtime before they can cause a silently broken page. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
setupFilesAfterFrameworktypo injest.config.js→ corrected tosetupFilesAfterEnvPages
//practices/practices/[slug]/aboutTest plan
npm test→ 7 tests, all passing, no warningsnpm run build→ 12 static pages generated successfully, 0 errorsnpm run lint→ no ESLint errorsCloses PLT-998
🤖 Generated with Claude Code