Guidelines for Creating an Issue Report

To help us understand and resolve issues more efficiently, please follow these guidelines when reporting an issue. A well-documented issue report significantly improves the chances of a quick resolution.

Steps to Reproduce

Please provide a clear and detailed step-by-step description of how to reproduce the issue.

For example (Legioth's issue report)

1. Double-click on a text element to enable the inline editor.
2. Type in the new text.
3. Press [Enter] or click outside the input field.
4. Note the behavior and any discrepancies from expected behavior.

Describe the solution you'd like

Provide a clear and concise description of what you want to happen.

Describe alternatives you've considered

Provide information about other solutions you've tried or researched.

Environment Details and Additional context

Include the following information to help us replicate the environment in which the issue occurs:

• Vaadin and Hilla Framework Version: Specify the version numbers.
• Browser Information: Provide the browser version, manufacturer, and type (e.g., Chrome 96.0.4664.110).
• Copilot Version: Mention the version number of Copilot.
• Additional information: Is there anything else you can add about the proposal?

Obtaining Version Numbers

To get the version numbers for Vaadin, Hilla, the operating system, and your browser, you can simply use the left side panel, when Copilot is activated. This panel will contain all the version numbers, along with the Copilot version.

Additional Information

If possible, add screenshots or videos to provide visual context to the issue. This can often help clarify the problem more than text descriptions alone.

Screenshot/Video Guidelines

• Ensure the screenshots/videos clearly show the issue.
• Annotate screenshots if necessary to point out relevant areas.

Example Ideal Issue Reports

• https://github.com/vaadin/copilot/issues/3
• https://github.com/vaadin/copilot/issues/4

By following these guidelines, you can help us to be quick and effective solving your isssues :bow: