@@ -8,6 +8,8 @@ This document contains guidelines for GitHub Copilot to follow when assisting wi
88- Maintain thorough documentation with each code change
99- Update the Memory Log for all debugging and issue resolution
1010- Verify code quality through testing, linting, and type checking
11+ - ** NEVER push code that fails CI/CD pipeline tests**
12+ - ** Ensure all code passes npm run test, npm run lint, npm run type-check, and npm run build before commits**
1113- Communicate clearly about implementation choices and alternatives
1214
1315## TESTING PROTOCOLS [ PRIORITY: HIGHEST]
@@ -36,8 +38,15 @@ This document contains guidelines for GitHub Copilot to follow when assisting wi
3638### Test Verification
3739- Remind to run test suite after ANY code changes
3840- ALWAYS use terminal command: ` npm run test `
41+ - For specific test patterns use: ` npm test -- --testPathPatterns="pattern" `
3942- Run tests in terminal, not through other interfaces
4043
44+ ### GitHub PR Check Monitoring
45+ - Use ` gh pr checks <PR_NUMBER> --fail-fast --watch ` for real-time updates
46+ - Avoid using ` gh pr checks ` without flags as it may hang indefinitely
47+ - The ` --fail-fast ` flag ensures quick response when checks fail
48+ - The ` --watch ` flag provides live updates as checks complete
49+
4150## DOCUMENTATION STANDARDS [ PRIORITY: HIGH]
4251### Component Documentation
4352- CREATE/UPDATE in ` docs/components/ ` when:
@@ -93,6 +102,13 @@ This document contains guidelines for GitHub Copilot to follow when assisting wi
93102- MOVE to ` docs/IMPLEMENTED_CHANGES.md ` with timestamp when complete
94103- ENSURE template format for effective AI-assisted implementation
95104
105+ ### Planning Document Lifecycle Management
106+ - ** CLEAR** ` docs/PLANNED_CHANGES.md ` after completing major features/PRs
107+ - ** RESET** to template reference only to prepare for future work
108+ - ** DOCUMENT** completed changes in ` docs/IMPLEMENTED_CHANGES.md ` before clearing
109+ - ** COMMIT** the cleanup as part of PR completion process
110+ - ** MAINTAIN** clean slate for next development cycle
111+
96112### Template Usage for AI Agents
97113- ALWAYS use ` docs/templates/PLANNED_CHANGES_TEMPLATE.md ` when user requests new features
98114- COPY the complete template structure - never create partial specifications
@@ -198,6 +214,117 @@ This document contains guidelines for GitHub Copilot to follow when assisting wi
198214- CHECK for duplicate files in scripts directory
199215- RUN ` node scripts/check-markdown-links.js ` for link validation
200216
217+ ## MCP TOOL USAGE GUIDELINES [ PRIORITY: HIGH]
218+ ### Enhanced Problem-Solving Tools
219+ When these MCP tools are available, leverage them to enhance development workflows and problem-solving capabilities:
220+
221+ #### Sequential Thinking Tool
222+ ** Purpose** : Dynamic, step-by-step problem analysis and solution development
223+ ** When to Use** :
224+ - Breaking down complex implementation requirements
225+ - Planning multi-step refactoring or migration processes
226+ - Analyzing debugging challenges that require systematic investigation
227+ - Design decisions that need thorough evaluation of alternatives
228+ - Problems where the full scope isn't initially clear
229+ - Tasks requiring context maintenance across multiple development steps
230+
231+ ** Usage Guidelines** :
232+ - START with initial thought estimate but adjust ` totalThoughts ` as understanding deepens
233+ - USE ` isRevision ` and ` revisesThought ` to refine previous analysis
234+ - EMPLOY ` branchFromThought ` and ` branchId ` for exploring alternative approaches
235+ - SET ` nextThoughtNeeded ` to false only when satisfied with solution completeness
236+ - INCLUDE hypothesis generation and verification in the thinking process
237+ - DOCUMENT key insights in Memory Log after complex problem-solving sessions
238+
239+ ** Example Applications** :
240+ - Component migration planning with dependency analysis
241+ - Test strategy development for complex features
242+ - Architecture decisions requiring trade-off evaluation
243+ - Debugging multi-layered issues with unknown root causes
244+
245+ #### Time Management Tool
246+ ** Purpose** : Timezone-aware time handling and conversion
247+ ** When to Use** :
248+ - Documenting timestamps in Memory Log entries with timezone context
249+ - Planning development schedules across team timezones
250+ - Handling time-sensitive features or deployments
251+ - Converting meeting times or deadlines for global collaboration
252+ - Adding temporal context to development milestones
253+
254+ ** Usage Guidelines** :
255+ - USE ` get_current_time ` with specific IANA timezone names for accurate timestamps
256+ - APPLY ` convert_time ` when coordinating across multiple timezones
257+ - INCLUDE timezone information in all time-sensitive documentation
258+ - STANDARDIZE on UTC for internal logging, convert for user-facing times
259+
260+ ** Example Applications** :
261+ - Memory Log entry timestamps: "Debugging session started at 2024-01-15 14:30:00 EST"
262+ - Release planning: "Deploy window: 02:00 UTC (21:00 EST, 15:00 JST+1)"
263+ - Meeting coordination: "Code review at 16:00 CET converts to 10:00 EST"
264+
265+ #### Memory Knowledge Graph Tool
266+ ** Purpose** : Persistent knowledge management across development sessions
267+ ** When to Use** :
268+ - Tracking complex project relationships and dependencies
269+ - Maintaining developer context across long-term initiatives
270+ - Building institutional knowledge about codebase patterns
271+ - Documenting architectural decisions and their relationships
272+ - Creating searchable knowledge base of debugging solutions
273+
274+ ** Usage Guidelines** :
275+ ** Entity Creation** :
276+ - CREATE entities for: components, developers, issues, features, dependencies, patterns
277+ - USE descriptive ` entityType ` classifications: "component", "developer", "issue", "pattern", "dependency"
278+ - STORE atomic observations: one fact per observation entry
279+ - MAINTAIN consistent naming conventions for entity references
280+
281+ ** Relationship Mapping** :
282+ - DEFINE relations in active voice: "depends_on", "implements", "resolves", "authored_by"
283+ - MAP component dependencies, developer responsibilities, issue relationships
284+ - TRACK architectural patterns and their usage across codebase
285+ - DOCUMENT decision influences and implementation relationships
286+
287+ ** Knowledge Retrieval** :
288+ - USE ` search_nodes ` for finding related information during development
289+ - APPLY ` open_nodes ` to retrieve specific context for current work
290+ - LEVERAGE ` read_graph ` for comprehensive project understanding
291+ - QUERY before starting complex tasks to gather relevant historical context
292+
293+ ** Maintenance Practices** :
294+ - UPDATE observations when component behavior or architecture changes
295+ - ADD new relationships when dependencies or responsibilities shift
296+ - DELETE obsolete entities when components are removed or refactored
297+ - REGULAR cleanup of outdated observations and relationships
298+
299+ ** Integration with Memory Log** :
300+ - LINK Memory Log entries to relevant knowledge graph entities
301+ - CREATE entities for significant debugging sessions and their outcomes
302+ - REFERENCE knowledge graph findings in Memory Log documentation
303+ - MAINTAIN bidirectional references between systems
304+
305+ ### Tool Combination Strategies
306+ ** Sequential Thinking + Memory Graph** :
307+ - USE sequential thinking to analyze complex problems
308+ - STORE analysis outcomes and decision rationale in knowledge graph
309+ - REFERENCE previous similar analyses when facing comparable challenges
310+
311+ ** Time + Memory Graph** :
312+ - TIMESTAMP all knowledge graph updates with timezone context
313+ - TRACK temporal patterns in development issues and solutions
314+ - MAINTAIN historical timeline of architectural decisions
315+
316+ ** All Three Tools Together** :
317+ - ANALYZE problems systematically with sequential thinking
318+ - DOCUMENT solutions and context in knowledge graph with time stamps
319+ - BUILD comprehensive development intelligence over time
320+ - CREATE searchable institutional memory for future reference
321+
322+ ### Tool Availability Protocol
323+ - CHECK for tool availability before complex problem-solving sessions
324+ - INFORM users when enhanced capabilities are available
325+ - FALLBACK to standard approaches when tools unavailable
326+ - DOCUMENT enhanced workflows in Memory Log for process improvement
327+
201328## COMMIT GUIDELINES [ PRIORITY: HIGH]
202329### Frequent Commit Strategy
203330- COMMIT early and often to maintain development momentum
0 commit comments