This guide is intended to help users and support engineers:

1. Find answers when facing a problem, (e.g. bug) and/or
2. Find feature requests and discussion related to their current topic

before filing a new issue. This will help users discover answers and/or workarounds without needing to wait for a response, and will help the Web Chat team reproduce a reported bug more quickly.

1. Determining a Web Chat concern
2. Searching samples
3. Searching documentation
4. Searching FAQ
5. Searching the issues list
6. Searching the Changelog
7. Reporting a bug
8. Making a feature request
9. Reporting a new FAQ
10. Supporting material

First, please confirm that your question/concern/bug is related to Web Chat. If it is not, you will be better served searching for answers in another place. See the supporting material section for helpful links.

The question is NOT related to Web Chat if:

1. You are not using Web Chat
   1. Does the project use Microsoft Teams or another channel for your bot? If yes, you will probably not find helpful information here
2. Your topic is in regards to bot implementation, not the Web Chat client. You can use the following links as appropriate:
   1. For implementation questions, search/post a question on Stack Overflow Bot Framework tag
   2. For BotFramework SDK bugs:
      1. BotBuilder .NET repository
      2. BotBuilder JavaScript repository
      3. BotBuilder Python repository
      4. BotBuilder Java repository
3. Your bug involves an Adaptive Card that you can reproduce on the Adaptive Cards Designer
   1. To test your card in the Designer, copy-paste your card's json into the designer. If this card looks the same as your card in Web Chat, see the next sub-bullet
   2. To report an Adaptive Cards bug, search the Adaptive Cards repository
4. Your bug exists in other parts of your app/website (not just Web Chat)
5. Note: Web Chat implementation questions should be redirected to Stack Overflow
   1. Search samples for technical guidance of common Web Chat features
   2. For implementation questions, search/post a question on Stack Overflow Web Chat tag

The question IS related to Web Chat if:

1. The topic is related to the bot's UI
2. You are following a Web Chat sample or tutorial and discover a problem
3. You are bumping your version of Web Chat and notice a behavior change from code that worked previously
4. You can reproduce the bug in one browser (e.g. Microsoft Edge) but not another (e.g. Google Chrome)
   1. Note: this may be a browser bug, and therefore not within Web Chat's ability to fix/implement and will need to be reported to the appropriate team
5. The topic is Accessibility, and the problem only occurs in Web Chat
   1. Note: this may be an Assistive Technology (e.g. Windows Narrator, JAWS, NVDA, etc.) problem, and therefore not within Web Chat's ability to fix/implement and will need to be reported to the appropriate team
      1. Windows Narrator
      2. Accessibility Insights
      3. JAWS
      4. NVDA
      5. VoiceOver
      6. TalkBack
6. The topic is related to speech.
   1. Note: this may be a speech (Direct Line Speech, Cognitive Services, web browser speech) problem, and therefore not within Web Chat's ability to fix/implement and will need to be reported to the appropriate team
      1. Direct Line Speech
      2. Cognitive Services Speech SDK
      3. Web Speech API

For common implementation scenarios, the Web Chat repository includes a list of samples that may jumpstart your development.

• Samples list (includes demo bots and tutorials)

Feel free to peruse our documentation, which is sorted based on general topic. These docs include design decisions, implementation quirks, links to related topics, and more.

• Web Chat's repository documentation
• Microsoft Web Chat Docs

Web Chat has several commonly-asked questions, workarounds, and known dependency issues that may address the problem you are currently investigating. If a question comes up more than once, the Web Chat team adds the related issue to the FAQ list for easier perusal.

1. Navigate to the FAQ
2. Search for keywords related to your question (e.g. iOS, speech, or Dynamics 365)
   1. Use the brower's search function by pressing Ctrl + F (Windows) or Cmd + F (OSX)
3. Read the high-level information written in the FAQ. If you want more information, click the related link (as applicable)
4. If your FAQ search doesn't produce results, try different keywords, as there may be many ways the question has been asked previously
5. If you find an issue that discusses or resolves your problem, please chime in with a thumbsup or comment on that issue
6. If you haven't found what you are looking for, please move on to searching the issues list

The issues page is where all Web Chat-related discussion is tracked on GitHub. If you did not find something in the FAQ, you may still find it in issues because: a) This topic has not come up multiple times yet, b) It has not yet been added to the FAQ, or c) this topic has already been addressed in a previous discussion, bugfix, or new feature merge

1. Navigate to Web Chat's issues page
2. Using the searchbar, delete the text is:open from the searchbar
3. In the searchbar, type the keywords related to your topic
4. For more information on how to search through issues, see the GitHub search documentation
5. To add a topic to the FAQ, see Add a new FAQ

You can also look for issues by topic:

• Area: Accessibility
• Area: Direct Line Speech
• Area: Docs
• Area: Migration Support
• Area: React Native
• Area: Skills
• Area: Speech
• Area: SSO

If you find an issue that discusses or resolves your problem, please chime in with a thumbsup or comment on that issue.

If this section did not help you, please move on to reporting a bug or making a feature request.

All changes made to the Web Chat project are recorded in the repository's Changelog. Updates are sorted by release, with most-recent changes at the top of the file.

1. Navigate to the CHANGELOG.MD.
2. Search for keywords related to your question (e.g. iOS, speech, or Dynamics 365)
   1. Use the brower's search function by pressing Ctrl + F (Windows) or Cmd + F (OSX)
3. Follow the related links for details, design decisions, and implementation information
   1. PRs also include tests, which may help you find code that helps you achieve your experience goals

[Unreleased] changes have not yet been made generally available, and Web Chat users will need to test using Web Chat's latest bits.

The CHANGELOG format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Please note that the more visual detail, code, and implementation steps you provide, the more quickly we will be able to assist you.

Before posting your bug, be sure to remove or hide all PII (Personally identifiable information) in your screenshots, code, and details.

1. Begin by filing a new issue as a bug
2. Fill out each section as thoroughly as possible
   • The more detail you can provide us, the more quickly we can help you
     1. Screenshots
        • Screenshots are required for visual bugs. To upload a screenshot or video, see the following:
        • Take a screenshot on Windows
        • Record your screen on Windows
        • Take a screenshot on OSX
        • Record your screen on OSX
        • Take a screenshot on iOS
        • Record your screen on iOS
        • Take a screenshot or record your screen on Android
        • Upload a screenshot to GitHub Note: video files must be attached in .zip folders
     2. Version
        • The version of Web Chat in your app is required for all bug reports. This helps us quickly test the problem you are experiencing in the correct environment
        • See the information inside the creating a bug dialog for how to determine your version of Web Chat
     3. Describe the bug
        • List the environment details of where you are experiencing this bug as applicable, including:
          • Browser
          • Host app (JS, React, Angular, etc)
          • Type of Web Chat (CDN, npm, embed)
          • OS (Windows, iOS, etc)
        • List the console errors you are seeing, if any (screenshots of these also help)
        • Describe the bug as specifically as possible
        • Provide screenshots of any relevant network activity
          • Inspect the network panel in Microsoft Edge
          • Inspect network activity in Google Chrome
          • Use the network monitor on Mozilla Firefox
     4. Steps to reproduce
        • Provide a detailed step-by-step of how the bug is experienced (required). Be sure to include:
          • Typed or spoken commands
          • Dialog interactions (e.g. button clicks)
        • Provide the environment that reproduces the bug (required; see options below)
          • Link to a hosted 'basic bot' that reproduces your specific issue
            • This is the easiest way of avoiding the accidental exposure of PII, and guarantees that we can reproduce your issue
            • Deploy a bot to Azure
              • Since this is a temporary deployment, you can use the free pricing tier (F0) to avoid additional costs
          • Link to your existing bot (removing all PII)
          • Provide the settings and command(s) that reproduce the bug on the Web Chat Playground
        • If your bug is related to an Adaptive Card, please provide your card's json (with PII removed)
        • If your bug is related to an incoming activity, please provide the activity details (with PII removed)
     5. Expected behavior
        • Provide a summary of what you expect to happen when the scenario is working correctly
     6. Additional context (more info is better!)
        • Include links to any related samples, issues, pull requests, or documentation

Once you have determined that your desired enhancement has not been requested yet, feel free to make the request yourself.

1. Begin by filing a new issue as feature request
2. Describe your request
3. Describe use-cases for this feature
4. Include screencaps as applicable
5. Include links to any related samples, issues, pull requests, or documentation

In case you find a discussion that should be added to the FAQ, please let us know!

Leave a new comment on the FAQ, and we will add it to the main list.

Thanks for the help!

• Web Chat FAQ
• Web Chat labelling docs - this explains the labelling guidelines for GitHub issues, which may help you find what you are looking for
• Web Chat samples
• Web Chat Changelog
• Stack Overflow Web Chat tag
• Web Chat's repository documentation
• Microsoft Docs

• BotBuilder .NET repository
• BotBuilder JavaScript repository
• BotBuilder Python repository
• BotBuilder Java repository

• Windows Narrator
• Accessibility Insights
• JAWS
• NVDA
• VoiceOver
• TalkBack

• Adaptive Cards repository
• Adaptive Card Designer

• Direct Line Speech
• Cognitive Services Speech SDK
• Web Speech API

• Official GitHub documentation
• Upload a screenshot to GitHub Note: video files must be attached in .zip folders