Skip to content

AmazonQ.md

Latest commit

 

History

History
96 lines (75 loc) · 3.72 KB

AmazonQ.md

File metadata and controls

96 lines (75 loc) · 3.72 KB

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: MIT-0

Amazon Q Development Guidelines

Always follow these guidelines when assisting in development for the Amazon Q CLI.

AmazonQ.md

DO NOT create or modify an AmazonQ.md file unless I explicitly tell you to do so.

Python Best Practices

  • Use dedent() where possible for formatting multiline strings.
  • If Pydantic is used, be sure to use version 2.

Format & Lint

  • The project uses the Ruff Python formatter and linter.
    • E4: pycodestyle errors related to imports
    • E7: pycodestyle errors related to statement structure
    • E9: pycodestyle errors related to runtime errors
    • F: All Pyflakes error codes (detects various Python errors like undefined names)
    • extend-select = ["I"]: This adds the isort (I) rule set to the selected rules
  • After generating code, the AI Agent should execute make lint to fix format and lint issues in the code.
  • If errors cannot be fixed by the make lint, the AI agent should attempt to correct them in code.
  • If they can't be corrected in code, then the AI agent should exclude the
  • Do not modify the ruff.toml unless specifically asked to do so.

Pytest Best Practices

Test Organization

  • Tests are organized into two categories:
    • Unit tests: Located in lib/idp_common_pkg/tests/unit/
      • Unit tests should be self contained and run with no infrastructure or external system dependencies (database, s3 etc.)
    • Integration tests: Located in lib/idp_common_pkg/tests/integration/

Test Annotations

  • Always mark unit tests with @pytest.mark.unit decorator
  • Always mark integration tests with @pytest.mark.integration decorator
  • Example: 
    import pytest

@pytest.mark.unit
def test_my_unit_test():
    # Unit test implementation
    assert True
    
@pytest.mark.integration
def test_my_integration_test():
    # Integration test implementation
    assert True

Test Fixtures

  • Shared fixtures should be placed in conftest.py
  • Fixtures should be well-documented with docstrings
  • Example: 
    @pytest.fixture
def sample_document():
    """Provides a sample document for testing."""
    return Document(id="test-doc", input_key="test.pdf")

Developing Tests

  • Unit and integration tests use the PyTest framework.
  • Tests should be sensible and the minimum necessary to verify critical logic.
  • Where possible, try to make tests easy to maintain.
  • After generating unit tests, the AI agent should verify unit tests by running them all.
  • To run all unit tests, the AI agent can execute the make test -C lib/idp_common_pkg command and observe that all tests pass.
  • If all tests don't pass, then fix the test(s) that are failing.
  • Tests should not throw warnings, if warnings are found, fix these.
  • Integration tests should not be run by the AI agent during development.

CI/CD Integration

  • Tests are run automatically in CI/CD pipeline
  • Unit tests run on all branches in the develop_tests stage
  • Integration tests run on develop branch automatically and on feature branches manually
  • Both test results and coverage reports are collected as artifacts

Coding Guidelines

  • Split files into smaller, focused units when appropriate:
    • Aim to keep code files under 350 lines. If a file exceeds 350 lines, split it into multiple files based on functionality.
  • Add comments to clarify non-obvious logic. Ensure all comments are written in English.
  • Provide corresponding unit tests for all new features.
  • After implementation, verify changes by running: 
    make lint  # Ensure code style compliance
make test -C lib/idp_common_pkg  # Verify all tests pass