Create AI Guidelines Markdowns #3428
Conversation
📝 WalkthroughWalkthroughTwo new comprehensive guideline documents have been added, providing detailed instructions on code style, TypeScript usage, GraphQL and database handling, project structure, coding standards, and tagged comments for the CORD API v3 backend project. No modifications were made to code or exported/public entities. 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
🧹 Nitpick comments (9)
.junie/guidelines.md (4)
3-3: Use official name “Node.js” instead of “NodeJS”.
The term “NodeJS” appears at lines 3 and 14; the correct, official spelling is “Node.js” to maintain consistency and adhere to common usage.Also applies to: 14-14
🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. The API serves the CORD Fie...(NODE_JS)
7-7: Replace placeholder with concrete API description.
The overview still contains a placeholder ([describe functionality briefly …]). Please provide a concise summary of the CORD API v3’s core functionality to guide new contributors.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...ment for field operations; replace with specific details if available]. It runs by default on `h...(SPECIFIC_DETAILS)
1-1: Consolidate duplicate guideline documents.
This title and much of the content mirror.github/copilot-instructions.md. To avoid drift and reduce maintenance overhead, consider merging them into a single, authoritative guide or linking between them.
219-223: Vary bullet phrasing in “Coding Standards”.
Multiple bullets start with “Use”, which can feel repetitive. Consider rephrasing or grouping related items (e.g., formatting vs. naming) to improve readability.🧰 Tools
🪛 LanguageTool
[style] ~222-~222: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e for classes, interfaces, and enums. - Use kebab-case for new folders and files. -...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~223-~223: 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)
.github/copilot-instructions.md (5)
3-3: Use official name “Node.js” instead of “NodeJS”.
The introduction uses “NodeJS”; update it to “Node.js” for consistency with the wider ecosystem.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. The API serves the CORD Fie...(NODE_JS)
7-7: Replace placeholder with concrete API description.
The overview section still contains a placeholder ([describe functionality briefly …]). Please fill in the specific responsibilities or features of the CORD API v3.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...ment for field operations; replace with specific details if available]. It runs by default on `h...(SPECIFIC_DETAILS)
14-14: Use official name “Node.js” instead of “NodeJS”.
The prerequisites list refers to “NodeJS”; change it to “Node.js” for accuracy.🧰 Tools
🪛 LanguageTool
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...rom official website, not Homebrew). 2. NodeJS (version as specified inpackage.json...(NODE_JS)
1-1: Consolidate duplicate guideline documents.
This file largely duplicates.junie/guidelines.md. To prevent inconsistencies, consider maintaining a single version or clearly indicating which document is authoritative.
220-224: Vary bullet phrasing in “Coding Standards”.
Several items begin with “Use”; grouping similar standards or altering sentence structures will enhance readability and reduce monotony.🧰 Tools
🪛 LanguageTool
[style] ~222-~222: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e for classes, interfaces, and enums. - Use kebab-case for new folders and files. -...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~223-~223: 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)
📜 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
.github/copilot-instructions.md
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. The API serves the CORD Fie...
(NODE_JS)
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...ment for field operations; replace with specific details if available]. It runs by default on `h...
(SPECIFIC_DETAILS)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...rom official website, not Homebrew). 2. NodeJS (version as specified in package.json...
(NODE_JS)
[uncategorized] ~210-~210: Loose punctuation mark.
Context: ...opment. ### Project Structure - src/: Source code - src/common/: Common u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~212-~212: Loose punctuation mark.
Context: ...Script interfaces. - src/components/: Feature-specific modules (e.g., user,...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~213-~213: Loose punctuation mark.
Context: ...s, and tests subfolders. - src/core/: Core functionality, such as database co...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...connections and GraphQL setup. - test/: E2E tests - test/utility/: Test uti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~216-~216: Loose punctuation mark.
Context: ...es (e.g., test app setup). - dbschema/: Database schema definitions and migrati...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~222-~222: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e for classes, interfaces, and enums. - Use kebab-case for new folders and files. -...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~223-~223: 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] ~279-~279: Did you mean “?”
Context: ... ('foo' in obj)) or optional chaining (?.`) for dynamic data. - Example (Correc...
(MULTIPLE_PUNCTATION_MARKS_1)
[misspelling] ~304-~304: This word is normally spelled as one.
Context: ...r class-validator in resolvers. - Use // ai anti-pattern to mark unvalidated inputs. ### Type ...
(EN_COMPOUNDS_ANTI_PATTERN)
[uncategorized] ~321-~321: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~323-~323: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~324-~324: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~326-~326: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~327-~327: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - type-safety`:...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~329-~329: Loose punctuation mark.
Context: ...: Exemplary test case. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~337-~337: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ces in src/components/*/service.ts. - Place DTOs in src/components/*/dto/*.dto.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~338-~338: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s in src/components/*/dto/*.dto.ts. - Place interfaces in src/common. - Place uni...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~339-~339: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .... - Place interfaces in src/common. - Place unit tests in `src/components//tests/...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~340-~340: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n src/components/*/tests/*.spec.ts. - Place E2E tests in test/*.e2e-spec.ts. ## ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~346-~346: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... async/await, and const over let. - Use strict TypeScript with DTOs (*.dto.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
.junie/guidelines.md
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. The API serves the CORD Fie...
(NODE_JS)
[style] ~7-~7: This phrase is redundant. Consider writing “details”.
Context: ...ment for field operations; replace with specific details if available]. It runs by default on `h...
(SPECIFIC_DETAILS)
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ... Prerequisites 1. Docker (install from official website, not Homebrew). 2. NodeJS (vers...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~14-~14: The official spelling of this programming framework is “Node.js”.
Context: ...rom official website, not Homebrew). 2. NodeJS (version as specified in package.json...
(NODE_JS)
[uncategorized] ~90-~90: You might be missing the article “the” here.
Context: ...s. - End-to-end (E2E) tests: Located in test directory, with .e2e-spec.ts ext...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~210-~210: Loose punctuation mark.
Context: ...opment. ### Project Structure - src/: Source code - src/common/: Common u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~212-~212: Loose punctuation mark.
Context: ...Script interfaces. - src/components/: Feature-specific modules (e.g., user,...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~213-~213: Loose punctuation mark.
Context: ...s, and tests subfolders. - src/core/: Core functionality, such as database co...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...connections and GraphQL setup. - test/: E2E tests - test/utility/: Test uti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~216-~216: Loose punctuation mark.
Context: ...es (e.g., test app setup). - dbschema/: Database schema definitions and migrati...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~222-~222: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e for classes, interfaces, and enums. - Use kebab-case for new folders and files. -...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~223-~223: 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] ~279-~279: Did you mean “?”
Context: ... ('foo' in obj)) or optional chaining (?.`) for dynamic data. - Example (Correc...
(MULTIPLE_PUNCTATION_MARKS_1)
[misspelling] ~304-~304: This word is normally spelled as one.
Context: ...r class-validator in resolvers. - Use // ai anti-pattern to mark unvalidated inputs. ### Type ...
(EN_COMPOUNDS_ANTI_PATTERN)
[uncategorized] ~321-~321: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~323-~323: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~324-~324: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~326-~326: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~327-~327: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - type-safety`:...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~329-~329: Loose punctuation mark.
Context: ...: Exemplary test case. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~337-~337: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ces in src/components/*/service.ts. - Place DTOs in src/components/*/dto/*.dto.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~338-~338: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s in src/components/*/dto/*.dto.ts. - Place interfaces in src/common. - Place uni...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~339-~339: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .... - Place interfaces in src/common. - Place unit tests in `src/components//tests/...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~340-~340: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n src/components/*/tests/*.spec.ts. - Place E2E tests in test/*.e2e-spec.ts. ## ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~346-~346: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... async/await, and const over let. - Use strict TypeScript with DTOs (*.dto.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (12)
- GitHub Check: Unit
- GitHub Check: E2E Tests (neo4j 6/6)
- GitHub Check: E2E Tests (neo4j 5/6)
- GitHub Check: E2E Tests (neo4j 4/6)
- GitHub Check: E2E Tests (neo4j 3/6)
- GitHub Check: E2E Tests (neo4j 2/6)
- GitHub Check: E2E Tests (neo4j 1/6)
- GitHub Check: Generate (head)
- GitHub Check: Generate (base)
- GitHub Check: lint
- GitHub Check: Clean
- GitHub Check: Analyze (javascript)
rdonigian
force-pushed
the
copilot-instructions
branch
from
18d232b to
8c5fc6b
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
.github/copilot-instructions.md (1)
1-100:⚠️ Potential issueDuplicate guideline documents across repository
The content in this file largely overlaps with.junie/guidelines.md. Maintaining two copies of the same guidelines increases the risk of divergence and extra upkeep. Consider consolidating into a single source of truth or having one file reference the other.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. ### Code Style The projec...(NODE_JS)
[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...opment. ### Project Structure -src/: Source code -src/common/: Common u...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...Script interfaces. -src/components/: Feature-specific modules (e.g.,user,...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...s, and tests subfolders. -src/core/: Core functionality, such as database co...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ...connections and GraphQL setup. -test/: E2E tests -test/utility/: Test uti...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...es (e.g., test app setup). -dbschema/: Database schema definitions and migrati...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ... practice or model code. -edge-case: Necessary deviation from standards. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...tion from standards. -best-practice: Adherence to coding standards. - `ant...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~76-~76: Loose punctuation mark.
Context: ... to coding standards. -anti-pattern: Code to avoid (pending refactor). - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... to avoid (pending refactor). -todo: Needs improvement or refactoring. - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...ovement or refactoring. -workaround: Temporary fix for a limitation. - `pe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ... fix for a limitation. -performance: Optimized code. -security: Securit...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ormance: Optimized code. -security: Security-critical code. -test`: Exe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...ity: Security-critical code. -test: Exemplary test case. -type-safety`:...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...: Exemplary test case. -type-safety: Safe property access. - Optionally add ...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~90-~90: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ces insrc/components/*/service.ts. - Place DTOs insrc/components/*/dto/*.dto.ts...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~91-~91: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s insrc/components/*/dto/*.dto.ts. - Place interfaces insrc/common. - Place uni...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~92-~92: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .... - Place interfaces insrc/common. - Place unit tests in `src/components//tests/...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~93-~93: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...nsrc/components/*/tests/*.spec.ts. - Place E2E tests intest/*.e2e-spec.ts. ## ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~99-~99: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... async/await, andconstoverlet. - Use strict TypeScript with DTOs (*.dto.ts...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
♻️ Duplicate comments (2)
.junie/guidelines.md (2)
1-100: Duplicate guideline documents across repository
This file is essentially identical to.github/copilot-instructions.md. To avoid confusion and reduce maintenance overhead, merge or remove one of these documents.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. ### Code Style The projec...(NODE_JS)
[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...opment. ### Project Structure -src/: Source code -src/common/: Common u...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...Script interfaces. -src/components/: Feature-specific modules (e.g.,user,...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...s, and tests subfolders. -src/core/: Core functionality, such as database co...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ...connections and GraphQL setup. -test/: E2E tests -test/utility/: Test uti...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...es (e.g., test app setup). -dbschema/: Database schema definitions and migrati...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ... practice or model code. -edge-case: Necessary deviation from standards. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...tion from standards. -best-practice: Adherence to coding standards. - `ant...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~76-~76: Loose punctuation mark.
Context: ... to coding standards. -anti-pattern: Code to avoid (pending refactor). - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... to avoid (pending refactor). -todo: Needs improvement or refactoring. - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...ovement or refactoring. -workaround: Temporary fix for a limitation. - `pe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ... fix for a limitation. -performance: Optimized code. -security: Securit...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ormance: Optimized code. -security: Security-critical code. -test`: Exe...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...ity: Security-critical code. -test: Exemplary test case. -type-safety`:...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...: Exemplary test case. -type-safety: Safe property access. - Optionally add ...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~90-~90: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ces insrc/components/*/service.ts. - Place DTOs insrc/components/*/dto/*.dto.ts...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~91-~91: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s insrc/components/*/dto/*.dto.ts. - Place interfaces insrc/common. - Place uni...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~92-~92: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .... - Place interfaces insrc/common. - Place unit tests in `src/components//tests/...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~93-~93: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...nsrc/components/*/tests/*.spec.ts. - Place E2E tests intest/*.e2e-spec.ts. ## ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~99-~99: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... async/await, andconstoverlet. - Use strict TypeScript with DTOs (*.dto.ts...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
3-3: Standardize framework spelling to Node.js
Align with official documentation by using “Node.js” instead of “NodeJS.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. ### Code Style The projec...(NODE_JS)
🧹 Nitpick comments (1)
.github/copilot-instructions.md (1)
3-3: Standardize framework spelling to Node.js
Use the official casing “Node.js” instead of “NodeJS” for accuracy and consistency.Apply this diff:
- This document provides guidelines for developers working on the CORD API v3 project, a backend built with NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. + This document provides guidelines for developers working on the CORD API v3 project, a backend built with NestJS, GraphQL, and Neo4j/Gel, using Node.js and Docker.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. ### Code Style The projec...(NODE_JS)
📜 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
.github/copilot-instructions.md
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. ### Code Style The projec...
(NODE_JS)
[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...opment. ### Project Structure - src/: Source code - src/common/: Common u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...Script interfaces. - src/components/: Feature-specific modules (e.g., user,...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...s, and tests subfolders. - src/core/: Core functionality, such as database co...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ...connections and GraphQL setup. - test/: E2E tests - test/utility/: Test uti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...es (e.g., test app setup). - dbschema/: Database schema definitions and migrati...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~76-~76: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - type-safety`:...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...: Exemplary test case. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~90-~90: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ces in src/components/*/service.ts. - Place DTOs in src/components/*/dto/*.dto.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~91-~91: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s in src/components/*/dto/*.dto.ts. - Place interfaces in src/common. - Place uni...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~92-~92: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .... - Place interfaces in src/common. - Place unit tests in `src/components//tests/...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~93-~93: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n src/components/*/tests/*.spec.ts. - Place E2E tests in test/*.e2e-spec.ts. ## ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~99-~99: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... async/await, and const over let. - Use strict TypeScript with DTOs (*.dto.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
.junie/guidelines.md
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...h NestJS, GraphQL, and Neo4j/Gel, using NodeJS and Docker. ### Code Style The projec...
(NODE_JS)
[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...opment. ### Project Structure - src/: Source code - src/common/: Common u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...Script interfaces. - src/components/: Feature-specific modules (e.g., user,...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...s, and tests subfolders. - src/core/: Core functionality, such as database co...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ...connections and GraphQL setup. - test/: E2E tests - test/utility/: Test uti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...es (e.g., test app setup). - dbschema/: Database schema definitions and migrati...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ... practice or model code. - edge-case: Necessary deviation from standards. -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...tion from standards. - best-practice: Adherence to coding standards. - `ant...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~76-~76: Loose punctuation mark.
Context: ... to coding standards. - anti-pattern: Code to avoid (pending refactor). - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... to avoid (pending refactor). - todo: Needs improvement or refactoring. - `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...ovement or refactoring. - workaround: Temporary fix for a limitation. - `pe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ... fix for a limitation. - performance: Optimized code. - security: Securit...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ormance: Optimized code. - security: Security-critical code. - test`: Exe...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...ity: Security-critical code. - test: Exemplary test case. - type-safety`:...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...: Exemplary test case. - type-safety: Safe property access. - Optionally add ...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~90-~90: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ces in src/components/*/service.ts. - Place DTOs in src/components/*/dto/*.dto.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~91-~91: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s in src/components/*/dto/*.dto.ts. - Place interfaces in src/common. - Place uni...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~92-~92: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .... - Place interfaces in src/common. - Place unit tests in `src/components//tests/...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~93-~93: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...n src/components/*/tests/*.spec.ts. - Place E2E tests in test/*.e2e-spec.ts. ## ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~99-~99: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... async/await, and const over let. - Use strict TypeScript with DTOs (*.dto.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (12)
- GitHub Check: E2E Tests (neo4j 6/6)
- GitHub Check: E2E Tests (neo4j 5/6)
- GitHub Check: E2E Tests (neo4j 4/6)
- GitHub Check: E2E Tests (neo4j 3/6)
- GitHub Check: E2E Tests (neo4j 2/6)
- GitHub Check: Generate (head)
- GitHub Check: E2E Tests (neo4j 1/6)
- GitHub Check: Clean
- GitHub Check: Generate (base)
- GitHub Check: Unit
- GitHub Check: lint
- GitHub Check: Analyze (javascript)
There was a problem hiding this comment.
Pull Request Overview
Adds foundational Markdown files outlining development guidelines for the CORD API v3 project.
- Introduces a general guidelines document under
.junie/ - Adds a duplicate guidelines document under
.github/intended for Copilot instructions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .junie/guidelines.md | New comprehensive CORD API development guidelines |
| .github/copilot-instructions.md | Identical guidelines added under a Copilot instructions filename |
Comments suppressed due to low confidence (1)
.github/copilot-instructions.md:1
- The filename suggests Copilot-specific instructions, but the content duplicates the CORD API guidelines. Consider renaming the file or adjusting its content to match its intended purpose.
# CORD API Development Guidelines
| - Run `yarn format` to format code using Prettier. | ||
| - Enforce TypeScript strict mode (`tsconfig.json` with `strict: true`). | ||
|
|
||
| ### GraphQL |
There was a problem hiding this comment.
[nitpick] The '### GraphQL' section is duplicated by the later '### GraphQL Guidelines'. Consider merging these to avoid redundant content and keep the document concise.
| ### GraphQL | |
| ### GraphQL Guidelines |
Copilot uses AI. Check for mistakes.
| - Create migrations with `yarn gel:migration` to update the database schema. | ||
| - Generate seed data with `yarn gel:seed` for testing or development. | ||
|
|
||
| ### Project Structure |
There was a problem hiding this comment.
[nitpick] The '### Project Structure' heading appears a second time at line 86. Consolidate these sections to remove duplication and improve readability.
Copilot uses AI. Check for mistakes.
|
Can we not duplicate this file in two different spots? Is the path configurable on either tool? maybe we can symlink instead? |
There was a problem hiding this comment.
This is AI slop :/
Wrong info, duplicated info, irrelevant connections, standards info explicitly spelled out that is just industry best practice.
All of this info can be obtained by looking at the codebase.
If AI is able to make this doc, then why does AI needs this doc?
No description provided.