Nota:
- Los ejemplos de esta biblioteca están pensados para inspirarte: te recomendamos que los ajustes para que sean más específicos para tus proyectos, lenguajes y procesos de equipo.
- Para obtener ejemplos aportados por la comunidad de instrucciones personalizadas para lenguajes y escenarios específicos, consulta el repositorio Awesome GitHub Copilot Customizations.
- Puedes aplicar instrucciones personalizadas en distintos ámbitos, en función de la plataforma o IDE donde las crees. Para obtener más información, vea «Acerca de la personalización de las respuestas de GitHub Copilot Chat».
En este ejemplo se muestra un archivo python-tests.instructions.md
específico de la ruta de acceso que solo se aplica a los archivos de prueba de Python del repositorio, mediante el campo applyTo
. Para más información sobre los archivos de instrucciones específicos de la ruta de acceso, consulta Incorporación de instrucciones personalizadas del repositorio para GitHub Copilot.
--- applyTo: "tests/**/*.py" --- When writing Python tests: ## Test Structure Essentials - Use pytest as the primary testing framework - Follow AAA pattern: Arrange, Act, Assert - Write descriptive test names that explain the behavior being tested - Keep tests focused on one specific behavior ## Key Testing Practices - Use pytest fixtures for setup and teardown - Mock external dependencies (databases, APIs, file operations) - Use parameterized tests for testing multiple similar scenarios - Test edge cases and error conditions, not just happy paths ## Example Test Pattern ```python import pytest from unittest.mock import Mock, patch class TestUserService: @pytest.fixture def user_service(self): return UserService() @pytest.mark.parametrize("invalid_email", ["", "invalid", "@test.com"]) def test_should_reject_invalid_emails(self, user_service, invalid_email): with pytest.raises(ValueError, match="Invalid email"): user_service.create_user({"email": invalid_email}) @patch('src.user_service.email_validator') def test_should_handle_validation_failure(self, mock_validator, user_service): mock_validator.validate.side_effect = ConnectionError() with pytest.raises(ConnectionError): user_service.create_user({"email": "[email protected]"}) ```
---
applyTo: "tests/**/*.py"
---
When writing Python tests:
## Test Structure Essentials
- Use pytest as the primary testing framework
- Follow AAA pattern: Arrange, Act, Assert
- Write descriptive test names that explain the behavior being tested
- Keep tests focused on one specific behavior
## Key Testing Practices
- Use pytest fixtures for setup and teardown
- Mock external dependencies (databases, APIs, file operations)
- Use parameterized tests for testing multiple similar scenarios
- Test edge cases and error conditions, not just happy paths
## Example Test Pattern
```python
import pytest
from unittest.mock import Mock, patch
class TestUserService:
@pytest.fixture
def user_service(self):
return UserService()
@pytest.mark.parametrize("invalid_email", ["", "invalid", "@test.com"])
def test_should_reject_invalid_emails(self, user_service, invalid_email):
with pytest.raises(ValueError, match="Invalid email"):
user_service.create_user({"email": invalid_email})
@patch('src.user_service.email_validator')
def test_should_handle_validation_failure(self, mock_validator, user_service):
mock_validator.validate.side_effect = ConnectionError()
with pytest.raises(ConnectionError):
user_service.create_user({"email": "[email protected]"})
```