chore: add custom copilot instructions COMPASS-10013

.github/copilot-instructions.md

@@ -0,0 +1,30 @@
+Do not include an overview section in your reviews.
+
+When reviewing code, focus on:
+
+## Performance Red Flags
+
+- Spot inefficient loops and algorithmic issues
+- Check for memory leaks and resource cleanup
+
+## Code Quality Essentials
+
+- Functions should be focused and appropriately sized
+- Use clear, descriptive naming conventions
+- Ensure proper error handling throughout
+- Suggest changes to improve code readability and maintainability
+
+## Best practices
+
+- Refer to official documentation and best practices for React.js, Redux and Node.js. If you see anti-patterns, highlight them and provide links to the relevant official documentation.
+
+## Review Style
+
+- Be specific and actionable in feedback
+- Explain the "why" behind recommendations
+
+## MongoDB Specifics
+
+### Performance antipatterns
+
+- Warn about db.stats() performance implications, especially in connection with freeStorage: 1. Provide a reference to the official MongoDB documentation.

packages/compass-data-modeling/src/components/diagram-editor.tsx

@@ -233,6 +233,12 @@ const DiagramContent: React.FunctionComponent<{
     isNewlyCreatedDiagram ?? false
   );
 
+  // This is an antipattern example to be detected by Copilot reviewer
+  const [obj, setObj] = useState({ a: '' });
+  useEffect(() => {
+    obj.a = 'abc';
+  }, [obj]);
+
   const setDiagramContainerRef = useCallback((ref: HTMLDivElement | null) => {
     if (ref) {
       // For debugging purposes, we attach the diagram to the ref.