902d70d6b2
Add comprehensive coding guidelines for GitHub Copilot to improve quality and consistency of AI-generated code. Instructions cover C++ and Python development with language-specific best practices, build system usage, and testing workflows. Following GitHub Copilot's standard layout with general instructions in .github/copilot-instructions.md and language-specific files in .github/instructions/ directory using *.instructions.md naming. No backport: This change is only for developers in master, so it doesn't need to be backported. Closes scylladb/scylladb#25374
1.3 KiB
1.3 KiB
applyTo
| applyTo |
|---|
| **/*.py |
Python Guidelines
Important: Match existing code style. Some directories (like test/cqlpy and test/alternator) prefer simplicity over type hints and docstrings.
Style
- Follow PEP 8
- Use type hints for function signatures (unless directory style omits them)
- Use f-strings for formatting
- Line length: 160 characters max
- 4 spaces for indentation
Imports
Order: standard library, third-party, local imports
import os
import sys
import pytest
from cassandra.cluster import Cluster
from test.utils import setup_keyspace
Never use from module import *
Documentation
All public functions/classes need docstrings (unless the current directory conventions omit them):
def my_function(arg1: str, arg2: int) -> bool:
"""
Brief summary of function purpose.
Args:
arg1: Description of first argument.
arg2: Description of second argument.
Returns:
Description of return value.
"""
pass
Testing Best Practices
- Maintain bisectability: all tests must pass in every commit
- Mark currently-failing tests with
@pytest.mark.xfail, unmark when fixed - Use descriptive names that convey intent
- Docstrings/comments should explain what the test verifies and why, and if it reproduces a specific issue or how it fits into the larger test suite