Create AI Guidelines Markdowns #1664
Conversation
📝 WalkthroughWalkthroughTwo new documentation files have been added, each providing comprehensive front-end development guidelines for the CORD Field project. These documents detail project structure, coding standards, React and CSS guidelines, form development practices, common errors, and a system for tagged code comments to support maintainable and safe development. Changes
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
.github/copilot-instructions.md (1)
1-341: 🛠️ Refactor suggestionConsolidate duplicate documentation.
This content closely mirrors.junie/guidelines.md. Maintaining two identical files can lead to drift. Consider merging into a single source of truth (with cross-links) to improve maintainability.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...g., field data management; replace with specific details if available]. It connects to the CORD ...(SPECIFIC_DETAILS)
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missingblobproperty), upgrade NodeJS. 2. Corepack enabled (corepack enable...(NODE_JS)
[uncategorized] ~130-~130: Loose punctuation mark.
Context: ...aphql. ### Project Structure -src/: Source code -src/api/`: GraphQL que...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~132-~132: Loose punctuation mark.
Context: ...and API-related files. -src/common/: Utility TypeScript files (types, interf...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~133-~133: Loose punctuation mark.
Context: ...lidation schemas). -src/components/: Reusable React components (mostly TSX, ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~134-~134: Loose punctuation mark.
Context: ...Final Form components). -src/hooks/: Custom React hooks (TypeScript). - `s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~135-~135: Loose punctuation mark.
Context: ...ct hooks (TypeScript). -src/scenes/: Application-specific, non-reusable comp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...les), with subfolders. -src/server/: Razzle server configuration files. - ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~137-~137: Loose punctuation mark.
Context: ...er configuration files. -src/theme/: MUI theme configuration files. ### Cod...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~143-~143: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...React components, classes, and enums. - Use kebab-case for new folders and files. -...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~144-~144: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...kebab-case for new folders and files. - Use single quotes for strings, 2 spaces for...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[formatting] ~156-~156: Did you mean “?”
Context: ...nsrc/api. - Use optional chaining (?.) or type guards for safe property acce...(MULTIPLE_PUNCTATION_MARKS_1)
[style] ~163-~163: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...eventDefault()` unless necessary. - For new small components: - Pass most props to wrap...(EN_ADJ_ORDER)
[formatting] ~167-~167: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~265-~265: Possible missing comma found.
Context: ...resrc/apicomponents have consistent interfaces matching designs. - Only access propert...(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~296-~296: Did you mean “?”
Context: ...nsrc/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~329-~329: Loose punctuation mark.
Context: ... practice or model code. -edge-case: Necessary deviation from standards. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~330-~330: Loose punctuation mark.
Context: ...tion from standards. -best-practice: Adherence to coding standards. - `ant...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ... to coding standards. -anti-pattern: Code to avoid (pending refactor). - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~332-~332: Loose punctuation mark.
Context: ... to avoid (pending refactor). -todo: Needs improvement or refactoring. - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~333-~333: Loose punctuation mark.
Context: ...ovement or refactoring. -workaround: Temporary fix for a limitation. - `pe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ... fix for a limitation. -performance: Optimized code. -security: Securit...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~335-~335: Loose punctuation mark.
Context: ...ormance: Optimized code. -security: Security-critical code. -test`: Exe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~336-~336: Loose punctuation mark.
Context: ...ity: Security-critical code. -test: Exemplary test case. -design-alignm...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...mplary test case. -design-alignment: Matches or deviates from design specs. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~338-~338: Loose punctuation mark.
Context: ...tes from design specs. -type-safety: Safe property access. - Optionally add ...(UNLIKELY_OPENING_PUNCTUATION)
♻️ Duplicate comments (3)
.junie/guidelines.md (3)
7-7: Placeholder needs real content.
The placeholder[describe functionality briefly, e.g., field data management; replace with specific details if available]should be replaced with an actual project overview.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...g., field data management; replace with specific details if available]. It connects to the CORD ...(SPECIFIC_DETAILS)
13-14: Use official Node.js spelling.
ReplaceNodeJSwithNode.jsto use the correct official spelling.🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missingblobproperty), upgrade NodeJS. 2. Corepack enabled (corepack enable...(NODE_JS)
70-70: Add missing article for clarity.
Modify to:-- End-to-end (E2E) tests: Located in `test` directory (if applicable). +- End-to-end (E2E) tests: Located in the `test` directory (if applicable).🧰 Tools
🪛 LanguageTool
[uncategorized] ~70-~70: You might be missing the article “the” here.
Context: .... - End-to-end (E2E) tests: Located intest` directory (if applicable). ### Ru...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🧹 Nitpick comments (4)
.github/copilot-instructions.md (4)
1-1: Filename may not reflect content.
The filenamecopilot-instructions.mdsuggests guidance for GitHub Copilot, but the document contains front-end development guidelines. Consider renaming the file or relocating it to better match its purpose.
7-7: Placeholder needs real content.
The placeholder[describe functionality briefly, e.g., field data management; replace with specific details if available]should be replaced with an actual overview of the front-end’s functionality to improve clarity.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...g., field data management; replace with specific details if available]. It connects to the CORD ...(SPECIFIC_DETAILS)
13-14: Use official Node.js spelling.
ReplaceNodeJSwithNode.jsto match the official name.-1. NodeJS (current version or LTS recommended, >= 18.x as per `package.json`). +1. Node.js (current version or LTS recommended, >= 18.x as per `package.json`). - - Check version with `node -v`. If compilation errors occur (e.g., `Buffer` object missing `blob` property), upgrade NodeJS. + - Check version with `node -v`. If compilation errors occur (e.g., `Buffer` object missing `blob` property), upgrade Node.js.🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missingblobproperty), upgrade NodeJS. 2. Corepack enabled (corepack enable...(NODE_JS)
70-70: Add missing article for clarity.
Modify to:-- End-to-end (E2E) tests: Located in `test` directory (if applicable). +- End-to-end (E2E) tests: Located in the `test` directory (if applicable).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/copilot-instructions.md(1 hunks).junie/guidelines.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.junie/guidelines.md
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...g., field data management; replace with specific details if available]. It connects to the CORD ...
(SPECIFIC_DETAILS)
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...
(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missing blob property), upgrade NodeJS. 2. Corepack enabled (corepack enable...
(NODE_JS)
[uncategorized] ~70-~70: You might be missing the article “the” here.
Context: .... - End-to-end (E2E) tests: Located in test` directory (if applicable). ### Ru...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~130-~130: Loose punctuation mark.
Context: ...aphql. ### Project Structure - src/: Source code - src/api/`: GraphQL que...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~132-~132: Loose punctuation mark.
Context: ...and API-related files. - src/common/: Utility TypeScript files (types, interf...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~133-~133: Loose punctuation mark.
Context: ...lidation schemas). - src/components/: Reusable React components (mostly TSX, ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~134-~134: Loose punctuation mark.
Context: ...Final Form components). - src/hooks/: Custom React hooks (TypeScript). - `s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~135-~135: Loose punctuation mark.
Context: ...ct hooks (TypeScript). - src/scenes/: Application-specific, non-reusable comp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...les), with subfolders. - src/server/: Razzle server configuration files. - ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~137-~137: Loose punctuation mark.
Context: ...er configuration files. - src/theme/: MUI theme configuration files. ### Cod...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~143-~143: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...React components, classes, and enums. - Use kebab-case for new folders and files. -...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~144-~144: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...kebab-case for new folders and files. - Use single quotes for strings, 2 spaces for...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[formatting] ~156-~156: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards for safe property acce...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~160-~160: You might be missing the article “the” here.
Context: ...ty access. ### React Guidelines - Use key attribute only for dynamic lists (e...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~163-~163: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...eventDefault()` unless necessary. - For new small components: - Pass most props to wrap...
(EN_ADJ_ORDER)
[formatting] ~167-~167: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~265-~265: Possible missing comma found.
Context: ...re src/api components have consistent interfaces matching designs. - Only access propert...
(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~296-~296: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~329-~329: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~330-~330: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~332-~332: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~333-~333: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~335-~335: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~336-~336: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - design-alignm...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...mplary test case. - design-alignment: Matches or deviates from design specs. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~338-~338: Loose punctuation mark.
Context: ...tes from design specs. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
.github/copilot-instructions.md
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...g., field data management; replace with specific details if available]. It connects to the CORD ...
(SPECIFIC_DETAILS)
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...
(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missing blob property), upgrade NodeJS. 2. Corepack enabled (corepack enable...
(NODE_JS)
[uncategorized] ~130-~130: Loose punctuation mark.
Context: ...aphql. ### Project Structure - src/: Source code - src/api/`: GraphQL que...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~132-~132: Loose punctuation mark.
Context: ...and API-related files. - src/common/: Utility TypeScript files (types, interf...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~133-~133: Loose punctuation mark.
Context: ...lidation schemas). - src/components/: Reusable React components (mostly TSX, ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~134-~134: Loose punctuation mark.
Context: ...Final Form components). - src/hooks/: Custom React hooks (TypeScript). - `s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~135-~135: Loose punctuation mark.
Context: ...ct hooks (TypeScript). - src/scenes/: Application-specific, non-reusable comp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...les), with subfolders. - src/server/: Razzle server configuration files. - ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~137-~137: Loose punctuation mark.
Context: ...er configuration files. - src/theme/: MUI theme configuration files. ### Cod...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~143-~143: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...React components, classes, and enums. - Use kebab-case for new folders and files. -...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~144-~144: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...kebab-case for new folders and files. - Use single quotes for strings, 2 spaces for...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[formatting] ~156-~156: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards for safe property acce...
(MULTIPLE_PUNCTATION_MARKS_1)
[style] ~163-~163: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...eventDefault()` unless necessary. - For new small components: - Pass most props to wrap...
(EN_ADJ_ORDER)
[formatting] ~167-~167: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~265-~265: Possible missing comma found.
Context: ...re src/api components have consistent interfaces matching designs. - Only access propert...
(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~296-~296: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~329-~329: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~330-~330: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~332-~332: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~333-~333: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~335-~335: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~336-~336: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - design-alignm...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...mplary test case. - design-alignment: Matches or deviates from design specs. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~338-~338: Loose punctuation mark.
Context: ...tes from design specs. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: run
rdonigian
changed the title
rdonigian
changed the title
rdonigian
force-pushed
the
copilot-instructions
branch
from
6a23d40 to
383d05a
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (4)
.junie/guidelines.md (4)
7-7: Duplicate: Placeholder for project functionality description
This section also uses the “[describe functionality…]” placeholder. See related comment in.github/copilot‐instructions.mdline 7.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...g., field data management; replace with specific details if available]. It connects to the CORD ...(SPECIFIC_DETAILS)
13-14: Duplicate: Use “Node.js” spelling
Same correction applies here. Refer to comment in.github/copilot‐instructions.mdlines 13–14.🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missingblobproperty), upgrade NodeJS. 2. Corepack enabled (corepack enable...(NODE_JS)
69-69: Duplicate: Fix typo in GraphQL section
The “correlated folders af” typo appears again. See related comment in.github/copilot‐instructions.mdline 69.
115-116: Duplicate: Complete the Form Development section
This section is also missing its guidance/examples; see the comment in.github/copilot‐instructions.mdline 115.
🧹 Nitpick comments (3)
.github/copilot-instructions.md (3)
13-14: Use official “Node.js” spelling
The bullets refer to “NodeJS”, but the correct, official name is “Node.js”. Please update both occurrences for consistency.Apply:
-1. NodeJS (current version or LTS recommended, >= 18.x as per `package.json`). - - Check version with `node -v`. If compilation errors occur (e.g., `Buffer` object missing `blob` property), upgrade NodeJS. +1. Node.js (current version or LTS recommended, >= 18.x as per `package.json`). + - Check version with `node -v`. If compilation errors occur (e.g., `Buffer` object missing `blob` property), upgrade Node.js.🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missingblobproperty), upgrade NodeJS. 2. Corepack enabled (corepack enable...(NODE_JS)
69-69: Fix typo in GraphQL section
The phrase “defined in correlated folders af (e.g.,*.tsor*.graphql)” looks like a typo. Consider changing to “defined in related folders (e.g.,*.tsor*.graphql).”
1-2: Clarify the role of this document
The title and content largely duplicate the main guidelines in.junie/guidelines.md. If this file is specifically for Copilot/AI workflows, consider renaming the title or merging duplicate sections to reduce maintenance overhead.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/copilot-instructions.md(1 hunks).junie/guidelines.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.junie/guidelines.md
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...g., field data management; replace with specific details if available]. It connects to the CORD ...
(SPECIFIC_DETAILS)
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...
(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missing blob property), upgrade NodeJS. 2. Corepack enabled (corepack enable...
(NODE_JS)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...aphql. ### Project Structure - src/: Source code - src/api/`: GraphQL que...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...and API-related files. - src/common/: Utility TypeScript files (types, interf...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...lidation schemas). - src/components/: Reusable React components (mostly TSX, ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ...Final Form components). - src/hooks/: Custom React hooks (TypeScript). - `s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ct hooks (TypeScript). - src/scenes/: Application-specific, non-reusable comp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...les), with subfolders. - src/server/: Razzle server configuration files. - ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...er configuration files. - src/theme/: MUI theme configuration files. ### Cod...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~88-~88: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...React components, classes, and enums. - Use kebab-case for new folders and files. -...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~89-~89: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...kebab-case for new folders and files. - Use single quotes for strings, 2 spaces for...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[formatting] ~101-~101: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards for safe property acce...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~105-~105: You might be missing the article “the” here.
Context: ...ty access. ### React Guidelines - Use key attribute only for dynamic lists (e...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~108-~108: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...eventDefault()` unless necessary. - For new small components: - Pass most props to wrap...
(EN_ADJ_ORDER)
[formatting] ~112-~112: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....
(MULTIPLE_PUNCTATION_MARKS_1)
[formatting] ~209-~209: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~236-~236: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~237-~237: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~239-~239: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~240-~240: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~242-~242: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~243-~243: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - design-alignm...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...mplary test case. - design-alignment: Matches or deviates from design specs. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~245-~245: Loose punctuation mark.
Context: ...tes from design specs. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
.github/copilot-instructions.md
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...g., field data management; replace with specific details if available]. It connects to the CORD ...
(SPECIFIC_DETAILS)
[uncategorized] ~13-~13: The official spelling of this programming framework is “Node.js”.
Context: ...ion Instructions ### Prerequisites 1. NodeJS (current version or LTS recommended, >=...
(NODE_JS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...bject missing blob property), upgrade NodeJS. 2. Corepack enabled (corepack enable...
(NODE_JS)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...aphql. ### Project Structure - src/: Source code - src/api/`: GraphQL que...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...and API-related files. - src/common/: Utility TypeScript files (types, interf...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...lidation schemas). - src/components/: Reusable React components (mostly TSX, ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ...Final Form components). - src/hooks/: Custom React hooks (TypeScript). - `s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ct hooks (TypeScript). - src/scenes/: Application-specific, non-reusable comp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...les), with subfolders. - src/server/: Razzle server configuration files. - ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...er configuration files. - src/theme/: MUI theme configuration files. ### Cod...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~88-~88: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...React components, classes, and enums. - Use kebab-case for new folders and files. -...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~89-~89: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...kebab-case for new folders and files. - Use single quotes for strings, 2 spaces for...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[formatting] ~101-~101: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards for safe property acce...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~105-~105: You might be missing the article “the” here.
Context: ...ty access. ### React Guidelines - Use key attribute only for dynamic lists (e...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~108-~108: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...eventDefault()` unless necessary. - For new small components: - Pass most props to wrap...
(EN_ADJ_ORDER)
[formatting] ~112-~112: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~201-~201: Possible missing comma found.
Context: ...re src/api components have consistent interfaces matching designs. - Only access propert...
(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~209-~209: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~236-~236: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~237-~237: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~239-~239: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~240-~240: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~242-~242: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~243-~243: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - design-alignm...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...mplary test case. - design-alignment: Matches or deviates from design specs. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~245-~245: Loose punctuation mark.
Context: ...tes from design specs. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: run
🔇 Additional comments (1)
.junie/guidelines.md (1)
1-1: Validate file location and intent
The.juniedirectory may be unfamiliar to new contributors. Please confirm whether this file is intended for human developers, AI assistants, or both, and how it differs from.github/copilot-instructions.md.
rdonigian
force-pushed
the
copilot-instructions
branch
from
383d05a to
0df8aab
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
.github/copilot-instructions.md (1)
1-164: 🛠️ Refactor suggestionConsolidate duplicate guidelines
This file and.junie/guidelines.mdcontain the same front-end development standards. To maintain a single source of truth and reduce duplication, consider merging into one shared document and referencing it where needed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ...API v3. ### Project Structure -src/: Source code -src/api/: client setu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... operation management. -src/common/: Utility TypeScript files (types, interf...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...ypes, interfaces). -src/components/: Reusable React components (mostly TSX, ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...Final Form components). -src/hooks/: Custom React hooks (TypeScript). - `s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...ct hooks (TypeScript). -src/scenes/: Application-specific, non-reusable comp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...les), with subfolders. -src/server/: server-side code and configuration file...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...nd configuration files. -src/theme/: MUI theme configuration files. ### Cod...(UNLIKELY_OPENING_PUNCTUATION)
[formatting] ~30-~30: Did you mean “?”
Context: ...nsrc/api. - Use optional chaining (?.) or type guards for safe property acce...(MULTIPLE_PUNCTATION_MARKS_1)
[style] ~34-~34: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...ty access. ### React Guidelines - For new small components: - Pass most props to wrap...(EN_ADJ_ORDER)
[formatting] ~38-~38: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....(MULTIPLE_PUNCTATION_MARKS_1)
[formatting] ~129-~129: Did you mean “?”
Context: ...nsrc/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~152-~152: Loose punctuation mark.
Context: ... practice or model code. -edge-case: Necessary deviation from standards. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...tion from standards. -best-practice: Adherence to coding standards. - `ant...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ... to coding standards. -anti-pattern: Code to avoid (pending refactor). - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~155-~155: Loose punctuation mark.
Context: ... to avoid (pending refactor). -todo: Needs improvement or refactoring. - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~156-~156: Loose punctuation mark.
Context: ...ovement or refactoring. -workaround: Temporary fix for a limitation. - `pe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ... fix for a limitation. -performance: Optimized code. -security: Securit...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~158-~158: Loose punctuation mark.
Context: ...ormance: Optimized code. -security: Security-critical code. -test`: Exe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~159-~159: Loose punctuation mark.
Context: ...ity: Security-critical code. -test: Exemplary test case. -design-alignm...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...mplary test case. -design-alignment: Matches or deviates from design specs. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~161-~161: Loose punctuation mark.
Context: ...tes from design specs. -type-safety: Safe property access. - Optionally add ...(UNLIKELY_OPENING_PUNCTUATION)
♻️ Duplicate comments (1)
.github/copilot-instructions.md (1)
42-43: 🛠️ Refactor suggestionComplete the Form Development section
The “Form Development” heading and initial bullet remain without guidance or examples. Please flesh out this section with details on using Final Form,react-final-formcomponents, validation (e.g., Yup), and error handling patterns.
🧹 Nitpick comments (8)
.junie/guidelines.md (8)
1-4: Add a Table of Contents for better navigation
The document is extensive; a TOC at the top with links to major sections (Project Structure, Coding Standards, React Guidelines, etc.) will help contributors quickly find relevant guidance.
5-15: Project Structure Clarity
The directory list is clear. To onboard new team members faster, consider adding brief descriptions or linking to example files/patterns in each folder (e.g., howsrc/api/is structured in practice).🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ...API v3. ### Project Structure -src/: Source code -src/api/: client setu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... operation management. -src/common/: Utility TypeScript files (types, interf...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...ypes, interfaces). -src/components/: Reusable React components (mostly TSX, ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...Final Form components). -src/hooks/: Custom React hooks (TypeScript). - `s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...ct hooks (TypeScript). -src/scenes/: Application-specific, non-reusable comp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...les), with subfolders. -src/server/: server-side code and configuration file...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...nd configuration files. -src/theme/: MUI theme configuration files. ### Cod...(UNLIKELY_OPENING_PUNCTUATION)
34-39: Enhance React Guidelines with a code snippet
The prose is solid—consider including a small TSX example showing prop forwarding vs. wrapper proliferation to illustrate the best practice in code.🧰 Tools
🪛 LanguageTool
[style] ~34-~34: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...ty access. ### React Guidelines - For new small components: - Pass most props to wrap...(EN_ADJ_ORDER)
[formatting] ~38-~38: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....(MULTIPLE_PUNCTATION_MARKS_1)
46-50: Include responsive breakpoints in CSS Guidelines
It’s valuable to mention MUI’stheme.breakpointsfor adaptive layouts (e.g.,sx={{ [theme.breakpoints.up('sm')]: { width: 400 } }}). A quick example will guide developers toward responsive design.
51-75: Consider visual aids for layout examples
The parent- vs. child-owned centering examples are clear; adding rendered screenshots or a simple diagram could further drive home the difference for visual learners.
76-100: Clarifysxprop style ordering rationale
You might briefly note how control-first ordering aligns with CSS specificity or MUI style resolution, giving deeper insight into why the pattern improves maintainability.
124-147: Broaden common errors section
In addition to unsafe property access, consider highlighting other frequent pitfalls (stale closures in hooks, missingkeyin lists, improper dependency arrays) with mini-examples to make this guidance more holistic.🧰 Tools
🪛 LanguageTool
[formatting] ~129-~129: Did you mean “?”
Context: ...nsrc/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...(MULTIPLE_PUNCTATION_MARKS_1)
150-164: Refine tagged comments grep command
The note suggestsgit grep "ai ", but tags use// ai. For precision, update the command to:git grep "// ai"🧰 Tools
🪛 LanguageTool
[uncategorized] ~152-~152: Loose punctuation mark.
Context: ... practice or model code. -edge-case: Necessary deviation from standards. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...tion from standards. -best-practice: Adherence to coding standards. - `ant...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ... to coding standards. -anti-pattern: Code to avoid (pending refactor). - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~155-~155: Loose punctuation mark.
Context: ... to avoid (pending refactor). -todo: Needs improvement or refactoring. - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~156-~156: Loose punctuation mark.
Context: ...ovement or refactoring. -workaround: Temporary fix for a limitation. - `pe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ... fix for a limitation. -performance: Optimized code. -security: Securit...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~158-~158: Loose punctuation mark.
Context: ...ormance: Optimized code. -security: Security-critical code. -test`: Exe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~159-~159: Loose punctuation mark.
Context: ...ity: Security-critical code. -test: Exemplary test case. -design-alignm...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...mplary test case. -design-alignment: Matches or deviates from design specs. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~161-~161: Loose punctuation mark.
Context: ...tes from design specs. -type-safety: Safe property access. - Optionally add ...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/copilot-instructions.md(1 hunks).junie/guidelines.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.junie/guidelines.md
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ...API v3. ### Project Structure - src/: Source code - src/api/: client setu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... operation management. - src/common/: Utility TypeScript files (types, interf...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...ypes, interfaces). - src/components/: Reusable React components (mostly TSX, ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...Final Form components). - src/hooks/: Custom React hooks (TypeScript). - `s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...ct hooks (TypeScript). - src/scenes/: Application-specific, non-reusable comp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...les), with subfolders. - src/server/: server-side code and configuration file...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...nd configuration files. - src/theme/: MUI theme configuration files. ### Cod...
(UNLIKELY_OPENING_PUNCTUATION)
[formatting] ~30-~30: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards for safe property acce...
(MULTIPLE_PUNCTATION_MARKS_1)
[style] ~34-~34: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...ty access. ### React Guidelines - For new small components: - Pass most props to wrap...
(EN_ADJ_ORDER)
[formatting] ~38-~38: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....
(MULTIPLE_PUNCTATION_MARKS_1)
[formatting] ~129-~129: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~152-~152: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~155-~155: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~156-~156: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~158-~158: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~159-~159: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - design-alignm...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...mplary test case. - design-alignment: Matches or deviates from design specs. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~161-~161: Loose punctuation mark.
Context: ...tes from design specs. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
.github/copilot-instructions.md
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ...API v3. ### Project Structure - src/: Source code - src/api/: client setu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... operation management. - src/common/: Utility TypeScript files (types, interf...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...ypes, interfaces). - src/components/: Reusable React components (mostly TSX, ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...Final Form components). - src/hooks/: Custom React hooks (TypeScript). - `s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...ct hooks (TypeScript). - src/scenes/: Application-specific, non-reusable comp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...les), with subfolders. - src/server/: server-side code and configuration file...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...nd configuration files. - src/theme/: MUI theme configuration files. ### Cod...
(UNLIKELY_OPENING_PUNCTUATION)
[formatting] ~30-~30: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards for safe property acce...
(MULTIPLE_PUNCTATION_MARKS_1)
[style] ~34-~34: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...ty access. ### React Guidelines - For new small components: - Pass most props to wrap...
(EN_ADJ_ORDER)
[formatting] ~38-~38: Did you mean “?”
Context: ...rd />). - Use optional chaining (?.`) or type guards for object properties....
(MULTIPLE_PUNCTATION_MARKS_1)
[formatting] ~129-~129: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards (e.g., `if ('foo' in o...
(MULTIPLE_PUNCTATION_MARKS_1)
[uncategorized] ~152-~152: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~155-~155: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~156-~156: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~158-~158: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~159-~159: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - design-alignm...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...mplary test case. - design-alignment: Matches or deviates from design specs. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~161-~161: Loose punctuation mark.
Context: ...tes from design specs. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
| - Use custom form components with Final Form and react-final-form in `src/components/form`. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Expand Form Development section with examples
Currently there’s only a single bullet. Please add details on form validation (Yup schemas or equivalent), field-level error handling, submission flows, and a sample react-final-form setup using your custom components.
🤖 Prompt for AI Agents
In .junie/guidelines.md around lines 42 to 43, the Form Development section is
too brief and lacks practical examples. Expand this section by adding detailed
explanations and examples covering form validation using Yup schemas or similar,
how to handle field-level errors, the submission flow process, and a sample
setup of react-final-form using the custom form components located in
src/components/form. This will provide clearer guidance on implementing robust
forms.
| - Use single quotes for strings, 2 spaces for indentation. | ||
| - Prefer arrow functions for callbacks, async/await for GraphQL queries/mutations. | ||
| - Use `const` for constants, minimize `let` usage (e.g., except in try/catch). | ||
| - Use destructuring for objects/arrays, template literals for strings. | ||
| - Follow SOLID principles for modular, reusable, maintainable code. | ||
| - Avoid code duplication, deeply nested statements, hard-coded values. | ||
| - Use constants/enums instead of magic numbers/strings. | ||
| - Avoid mutations (non-GraphQL): | ||
| - Prefer `const` over `let`. | ||
| - Use spread syntax (e.g., `{ ...object, foo: 'bar' }`) instead of modifying objects. | ||
| - Use strict TypeScript: | ||
| - Define all object shapes in `src/common` or generated GraphQL types in `src/api`. | ||
| - Use optional chaining (`?.`) or type guards for safe property access. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Specify tooling for enforcing coding standards
Recommend calling out which linter/formatter configurations (ESLint, Prettier, etc.) enforce these rules automatically. This reduces manual overhead and ensures consistency across commits.
🧰 Tools
🪛 LanguageTool
[formatting] ~30-~30: Did you mean “?”
Context: ...n src/api. - Use optional chaining (?.) or type guards for safe property acce...
(MULTIPLE_PUNCTATION_MARKS_1)
🤖 Prompt for AI Agents
In .junie/guidelines.md around lines 18 to 31, the guidelines list coding
standards but do not specify which tooling enforces them. Add a section
recommending specific linters and formatters like ESLint and Prettier, including
their configuration files, to automatically enforce these rules. This will help
maintain consistency and reduce manual code review overhead.
I cut out the fluff and erroneous info. Let me know what you think about the tagged comments, I imagine us being able to slowly iterate on the examples for the ai as we build new functionality. |
No description provided.