Skip to content

Conversation

@ciscoRankush
Copy link

COMPLETES N/A - Documentation Enhancement

This pull request addresses

Adding comprehensive pattern documentation to guide AI assistants and developers on the coding standards and patterns used in the Contact Center Widgets codebase.

by making the following changes

  • Added ai-docs/patterns/typescript-patterns.md - TypeScript conventions, type definitions, and best practices
  • Added ai-docs/patterns/react-patterns.md - React component patterns, hooks, and lifecycle management
  • Added ai-docs/patterns/mobx-patterns.md - MobX state management patterns with observer HOC
  • Added ai-docs/patterns/web-component-patterns.md - r2wc patterns for Web Component wrappers
  • Added ai-docs/patterns/testing-patterns.md - Jest and Playwright testing patterns

Change Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

  • The testing is done with the amplify link

The GAI Coding Policy And Copyright Annotation Best Practices

  • GAI was not used (or, no additional notation is required)
  • Code was generated entirely by GAI
  • GAI was used to create a draft that was subsequently customized or modified
  • Coder created a draft manually that was non-substantively modified by GAI (e.g., refactoring was performed by GAI on manually written code)
  • Tool used for AI assistance (GitHub Copilot / Other - specify)
    • Github Copilot
    • Other - Please Specify: Cursor AI
  • This PR is related to
    • Feature
    • Defect fix
    • Tech Debt
    • Automation

Checklist before merging

  • I have not skipped any automated checks
  • All existing and new tests passed
  • I have updated the testing document
  • I have tested the functionality with amplify link

Make sure to have followed the contributing guidelines before submitting.

@aws-amplify-us-east-2
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-572.d1b38q61t1z947.amplifyapp.com

- Remove 'Files Analyzed' sections
- Remove 'Anti-Patterns Found' sections
- Remove analysis/summary paragraphs
- Make all guidance prescriptive (MUST, ALWAYS, NEVER)
- Focus on actionable patterns for LLM code generation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant