Create AI Guidelines Markdowns by rdonigian · Pull Request #1664 · SeedCompany/cord-field

rdonigian · 2025-05-14T15:37:05Z

No description provided.

coderabbitai · 2025-05-14T15:40:22Z

📝 Walkthrough

Walkthrough

Adds multiple frontend documentation files and example MCP server config; and removes many non-null (!) assertions when reading GraphQL mutation/query results across numerous components and scenes, changing null-safety assumptions without other logic changes.

Changes

Cohort / File(s)	Summary
Docs / Guidelines `.github/copilot-instructions.md`, `AGENTS.md`, `.junie/guidelines.md`	Added comprehensive frontend development and agent guidelines covering project structure, coding standards, React/CSS/form conventions, tagged comment system, and workflows.
MCP server examples & docs `.github/mcp-servers.example.json`, `.github/mcp-servers.md`	Added MCP server example JSON and explanatory documentation describing endpoints, scopes, allowed/blocked repos, secrets usage, and VS Code settings.
GraphQL null-safety changes (components & forms) `src/components/Comments/CommentForm/CreateComment.tsx`, `src/components/FieldRegion/CreateFieldRegion/CreateFieldRegion.tsx`, `src/components/FieldRegion/EditFieldRegion/EditFieldRegion.tsx`, `src/components/FieldZone/CreateFieldZone/CreateFieldZone.tsx`, `src/components/FieldZone/EditFieldZone/EditFieldZone.tsx`, `src/components/Tool/CreateTool/CreateTool.tsx`, `src/components/Tool/EditTool/EditTool.tsx`	Removed non-null assertions (`!`) when accessing GraphQL mutation/query results; accesses now use plain property access (e.g., `data.createX.x` instead of `data!.createX.x`). No other logic changes.
GraphQL null-safety changes (scenes - engagement/products/etc.) `src/scenes/Engagement/CeremonyCard/CeremonyPlanned.tsx`, `src/scenes/Engagement/LanguageEngagement/Product/Producibles/.../CreateEthnoArt.tsx`, `.../CreateFilm.tsx`, `.../CreateStory.tsx`, `src/scenes/Languages/Create/CreateLanguage.tsx`, `src/scenes/Languages/Edit/EditLanguage.tsx`, `src/scenes/Locations/Create/CreateLocation.tsx`, `src/scenes/Locations/LocationForm/FundingAccount/CreateFundingAccount.tsx`, `src/scenes/Partners/Create/CreatePartner.tsx`, `src/scenes/Products/Create/CreateProduct.tsx`, `src/scenes/Products/Edit/EditProduct.tsx`, `src/scenes/ProgressReports/.../ExplanationOfProgress.tsx`, `src/scenes/ProgressReports/.../ProgressStep.tsx`, `src/scenes/Projects/ChangeRequest/Create/CreateProjectChangeRequest.tsx`, `src/scenes/Projects/Files/CreateProjectDirectory.tsx`, `src/scenes/Projects/Members/List/ProjectMembersList.tsx`, `src/scenes/Users/Create/CreateUser.tsx`	Multiple files updated to remove forced non-null assertions when reading GraphQL responses or passing values (e.g., `engagement!`, `produces!.id`, `data!.createX`). Some optimisticResponse spreads had `!` removed. No control-flow or API changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Tools #1724: Edits removing non-null assertions in Tool create/edit components overlap with this PR's CreateTool/EditTool changes.
Create field region and zone page #1696: Prior changes touched CreateFieldRegion mutation handling; this PR similarly adjusts null-assert usage in that file.
Project Member Active/Inactive handling #1702: Related to ProjectMembersList changes — both PRs modify how project/members data is read and passed (removal of non-null assertions vs. prop refactor).

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to assess whether any description content relates to the changeset.	Add a brief description explaining the purpose of the AI guidelines markdowns and why they are being introduced to the project.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Create AI Guidelines Markdowns' directly and clearly summarizes the main change: adding new markdown files with AI development guidelines for the project.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch copilot-instructions

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🔭 Outside diff range comments (1)

.github/copilot-instructions.md (1)

1-341: 🛠️ Refactor suggestion

Consolidate 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 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)

♻️ 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.
Replace NodeJS with Node.js to 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 missing blob property), 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 in test` 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 filename copilot-instructions.md suggests 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.
Replace NodeJS with Node.js to 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 missing blob property), 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

📥 Commits

Reviewing files that changed from the base of the PR and between 72b3a57 and 6a23d40.

📒 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

CarsonF

There's a lot here that's incorrect.

There's a lot here that I don't feel like we need to call out.
"Use PascalCase for React Components"

coderabbitai

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.md line 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.md lines 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 missing blob property), 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.md line 69.

115-116: Duplicate: Complete the Form Development section
This section is also missing its guidance/examples; see the comment in .github/copilot‐instructions.md line 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 missing blob property), 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., *.ts or *.graphql)” looks like a typo. Consider changing to “defined in related folders (e.g., *.ts or *.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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a23d40 and 383d05a.

📒 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 .junie directory 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.

.github/copilot-instructions.md

coderabbitai

Actionable comments posted: 2

🔭 Outside diff range comments (1)

.github/copilot-instructions.md (1)

1-164: 🛠️ Refactor suggestion

Consolidate duplicate guidelines
This file and .junie/guidelines.md contain 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: ...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)

♻️ Duplicate comments (1)

.github/copilot-instructions.md (1)

42-43: 🛠️ Refactor suggestion

Complete 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-form components, 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., how src/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’s theme.breakpoints for 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: Clarify sx prop 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, missing key in lists, improper dependency arrays) with mini-examples to make this guidance more holistic.

🧰 Tools

🪛 LanguageTool

[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)

150-164: Refine tagged comments grep command
The note suggests git 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

📥 Commits

Reviewing files that changed from the base of the PR and between 383d05a and 0df8aab.

📒 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)

.junie/guidelines.md

rdonigian · 2025-05-15T12:45:40Z

There's a lot here that's incorrect.

There's a lot here that I don't feel like we need to call out. "Use PascalCase for React Components"

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.

copiot instructions

ba7fa31

rdonigian requested a review from CarsonF as a code owner May 14, 2025 15:37

coderabbitai bot reviewed May 14, 2025

View reviewed changes

rdonigian changed the title ~~Copilot Instructions Markdown~~ Create AI Guidelines Markdowns #3428 May 14, 2025

rdonigian changed the title ~~Create AI Guidelines Markdowns #3428~~ Create AI Guidelines Markdowns May 14, 2025

CarsonF reviewed May 14, 2025

View reviewed changes

rdonigian force-pushed the copilot-instructions branch from 6a23d40 to 383d05a Compare May 14, 2025 21:37

coderabbitai bot reviewed May 14, 2025

View reviewed changes

.github/copilot-instructions.md Outdated Show resolved Hide resolved

.github/copilot-instructions.md Outdated Show resolved Hide resolved

create ai guidelines

0df8aab

rdonigian force-pushed the copilot-instructions branch from 383d05a to 0df8aab Compare May 15, 2025 12:35

coderabbitai bot reviewed May 15, 2025

View reviewed changes

.junie/guidelines.md Show resolved Hide resolved

.junie/guidelines.md Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

sethmcknight force-pushed the copilot-instructions branch from 75ed2e4 to 0df8aab Compare February 11, 2026 20:03

rdonigian closed this Feb 17, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Create AI Guidelines Markdowns#1664

Create AI Guidelines Markdowns#1664
rdonigian wants to merge 2 commits intodevelopfrom
copilot-instructions

rdonigian commented May 14, 2025

Uh oh!

coderabbitai bot commented May 14, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Uh oh!

coderabbitai bot left a comment

Uh oh!

CarsonF left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

rdonigian commented May 15, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

rdonigian commented May 14, 2025

Uh oh!

coderabbitai bot commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

CarsonF left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rdonigian commented May 15, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

coderabbitai bot commented May 14, 2025 •

edited

Loading