Add copilot-instructions.md

.github/copilot-instructions.md

@@ -0,0 +1,69 @@
+## Code Review Guidelines
+
+Act as a Senior Staff Engineer reviewing code for the Neural Network Compression Framework (NNCF).
+Be concise, critical, and provide code examples for fixes.
+
+## Python Code Style Guidelines
+
+### Language Rules
+
+- Use nested functions/classes only when they make code more readable and simpler, or when closing over local variables.
+- Code must be annotated with type hints (PEP-484)
+- Use `pathlib.Path` instead of `os.*` methods
+- Avoid using `assert` statements in `src/nncf`, raise proper exceptions with informative messages instead
+
+### Style Rules
+
+**Format of docstrings**:
+
+```python
+def foo(arg1: int, arg2: bool = False) -> int:
+    """
+    Brief description of what the function does.
+
+    :param arg1: Description
+    :param arg2: Description
+    :return: Description
+    """
+```
+
+- All externally visible functions need docstrings unless very short, obvious, and not externally visible
+
+**Naming convention**
+
+- Modules/Packages: `lower_with_under`
+- Classes: `CapWords`
+- Functions/Methods: `lower_with_under()`
+- Constants: `CAPS_WITH_UNDER`
+- Variables: `lower_with_under`
+- Internal/Private: prefix with `_`
+- Avoid single char names (except `i j k v` for loops, `e` for exceptions, `f` for files, `a b x y z` for tensors)
+- Avoid dashes in package/module names
+- Avoid type suffixes in names (e.g., `id_to_name_dict`)
+
+**File naming**
+
+- Use `.py` extension, never dashes
+- Avoid generic names like `utils.py` or `helpers.py`
+- Group related code in dedicated, explicitly-named modules
+
+### Test Suite Rules
+
+**Basic Style**
+
+- Use pytest framework
+- Type-hint all parameters and fixtures
+- Use fixtures, not xunit-style setup/teardown
+
+### Review Focus Areas
+
+When reviewing code or suggesting changes, adhere to the following logic-first rules:
+
+- Look for performance issues, potential bottlenecks and memory leaks
+- Follow python code style guidelines
+- Grammar and clarity in docstrings and variable names
+- Proper use of type hints and annotations
+- Avoid comment about formatting issues, focus on code logic and style
+- Ensure that appropriate tests are added for the new code, and that they are well-structured, clear, and comply with the testing guidelines
+- Check for proper exception handling and informative error messages
+- Ensure that code is modular, reusable, and avoids unnecessary complexity