omnichannel-chat-sdk

# GitHub Copilot Instructions for Omnichannel Chat SDK

## Build Process    
To build the Omnichannel Chat SDK, follow these steps:
1. **Install Dependencies**: Run `npm install` to install all required dependencies
2. **Build the SDK**: Run `npm run build:tsc` to build the SDK
3. **Run Tests**: Execute `npm run test` to run all unit tests and ensure everything is functioning correctly
4. **Linting**: Run `npm run lint` to check for any code style

## Pull Request Guidelines

When creating pull requests, follow these guidelines:

1. **Code Standards**: Ensure your code adheres to the project's coding standards defined in `docs/copilot/CODING_GUIDELINES.md`
2. **Commit Messages**: Write clear and concise commit messages following conventional commit format
3. **Testing**: Include comprehensive tests for any new functionality or bug fixes
4. **Documentation**: Update documentation if necessary, including JSDoc comments
5. **Test Verification**: Ensure all tests pass before submitting the pull request
6. **Collaboration**: **ALWAYS** ask for explicit confirmation before proceeding with changes. Do not make any code modifications until explicitly authorized by the requester.
7. **Authorization Required**: For every change request, provide a detailed plan of what will be modified and wait for explicit approval before implementing
8. **Clarification**: If you are not sure about something, ask for clarification in the pull request comments
8. **Incremental Changes**: Consider breaking significant changes into smaller pull requests for easier review

## GitHub Copilot Behavior Guidelines

### Response Protocol
- **ASK FIRST**: Always ask for permission before making any code modifications
- **PROPOSE CHANGES**: Present a clear plan of what will be changed and why
- **WAIT FOR APPROVAL**: Do not proceed until receiving explicit "yes" or "proceed" confirmation
- **NO ASSUMPTIONS**: Never assume what the user wants - always clarify requirements
- **SUMMARIZE IMPACT**: Explain potential side effects or dependencies before implementing

### Example Response Pattern
When a user requests a change, respond with:
1. "I understand you want to [describe the request]"
2. "Here's what I propose to change: [detailed plan]"
3. "This will affect: [list of files and components]"
4. "Do you want me to proceed with these changes? (Yes/No)"
5. Wait for explicit confirmation before implementing

9. **Incremental Changes**: Consider breaking significant changes into smaller pull requests for easier review
9. **Bug Fixes**: Include a description of the issue and how it was resolved
10. **Changelog**: Always include a one-line summary of the change at the top of CHANGELOG.md under [Unreleased] section:
    - **Fixed**: for bugs
    - **Changed**: for improvements or modified functionality  
    - **Added**: for new features or components
11. **Testing Strategy**: Suggest manual tests and possible edge cases
12. **Documentation**: Add diagrams and explanations to help reviewers understand entry points and follow changes

## Coding Standards

### Essential Requirements
- **MUST follow**: All patterns and guidelines specified in `docs/copilot/CODING_GUIDELINES.md`
- **MUST use**: Prompt templates from `docs/copilot/PROMPT_TEMPLATES.md` when working with Copilot
- **Code Quality**: Write clear, concise, and well-documented code
- **Comments**: Add meaningful comments to explain complex business logic
- **Testing**: Include comprehensive unit tests to verify functionality
- **Error Handling**: Handle errors gracefully with proper telemetry logging
- **Review Process**: Code must be reviewed by at least one other developer before merging

### Omnichannel Chat SDK Specific Requirements
- **Telemetry**: Always implement the startScenario() → completeScenario()/failScenario() pattern
- **Error Structure**: Use ChatSDKExceptionDetails structure for all error handling
- **Type Safety**: Follow strict TypeScript practices with proper type definitions
- **Platform Compatibility**: Consider cross-platform compatibility (Browser, Node.js, React Native)
- **Method Structure**: Follow the standard async method pattern defined in coding guidelines
- **Configuration**: Respect feature flags and disable patterns throughout the codebase

### Development Workflow
- **Dependencies**: Suggest library updates or new dependencies, but do not implement unless explicitly requested
- **Test Coverage**: Ensure unit tests pass and maintain coverage standards
- **Component Dependencies**: When changes affect multiple components, clearly highlight this with warnings and impact analysis
- **Breaking Changes**: Identify and document any breaking changes with migration guidance

### Prohibited Actions
- **No Unauthorized Changes**: **NEVER** make code changes without explicit user approval. Always propose changes and wait for confirmation
- **No Silent Changes**: Do not make dependency updates without explicit approval
- **No Silent Failures**: Every error must be properly logged with telemetry
- **No Type Safety Violations**: Avoid using 'any' type without proper justification
- **No Inconsistent Patterns**: Follow established patterns consistently across the codebase

## Reference Documents
- **Coding Guidelines**: `docs/copilot/CODING_GUIDELINES.md` - Comprehensive coding standards and patterns
- **Prompt Templates**: `docs/copilot/PROMPT_TEMPLATES.md` - Ready-to-use templates for common development tasks
- **Development Guide**: `docs/DEVELOPMENT_GUIDE.md` - General development setup and guidelines
- **Troubleshooting**: `docs/TROUBLESHOOTING_GUIDE.md` - Common issues and solutions