name: 'Bug report'
description: Create a report to help us improve
body:
  - type: markdown
    attributes:
      value: |
        Thank you for reporting an issue :pray:.

        This issue tracker is for reporting bugs found in `foam` (https://github.com/foambubble).
        If you have a question about how to achieve something and are struggling, please post a question
        inside of either of the following places:
          - Foam's Discussion's tab: https://github.com/foambubble/foam/discussions
          - Foam's Discord channel: https://foambubble.github.io/join-discord/g
          

        Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
         - Foam's Issue's tab: https://github.com/foambubble/foam/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc
         - Foam's closed issues tab: https://github.com/foambubble/foam/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
         - Foam's Discussions tab: https://github.com/foambubble/foam/discussions

        The more information you fill in, the better the community can help you.
  - type: textarea
    id: description
    attributes:
      label: Describe the bug
      description: Provide a clear and concise description of the challenge you are running into.
    validations:
      required: true
  - type: input
    id: reproducible_example
    attributes:
      label: Small Reproducible Example
      description: |
        Note:
        - Your bug will may get fixed much faster if there is a way we can somehow run your example or code.
        - To create a shareable example, consider cloning the following Foam Github template: https://github.com/foambubble/foam-template
        - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
      placeholder: |
        e.g. Link to your github repository containing a small reproducible example that the team can run.
    validations:
      required: false
  - type: textarea
    id: steps
    attributes:
      label: Steps to Reproduce the Bug or Issue
      description: Describe the steps we have to take to reproduce the behavior.
      placeholder: |
        1. Go to '...'
        2. Click on '....'
        3. Scroll down to '....'
        4. See error
    validations:
      required: true
  - type: textarea
    id: expected
    attributes:
      label: Expected behavior
      description: Provide a clear and concise description of what you expected to happen.
      placeholder: |
        As a user, I expected ___ behavior but i am seeing ___
    validations:
      required: true
  - type: textarea
    id: screenshots_or_videos
    attributes:
      label: Screenshots or Videos
      description: |
        If applicable, add screenshots or a video to help explain your problem.
        For more information on the supported file image/file types and the file size limits, please refer
        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
      placeholder: |
        You can drag your video or image files inside of this editor ↓
  - type: input
    id: os
    attributes:
      label: Operating System Version
      description: What opearting system are you using?
      placeholder: |
        - OS: [e.g. macOS, Windows, Linux]
    validations:
      required: true
  - type: input
    id: vscode_version 
    attributes:
      label: Visual Studio Code Version
      description: |
        What version of Visual Studio Code are you using?
        How to find Visual Studio Code Version: https://code.visualstudio.com/docs/supporting/FAQ#_how-do-i-find-the-version
    validations:
      required: true
  - type: textarea
    id: additional
    attributes:
      label: Additional context
      description: | 
        Add any other context about the problem here.
        The Foam log output for VSCode can be found here: https://github.com/foambubble/foam/blob/master/docs/features/foam-logging-in-vscode.md