Skip to content

Commit

Permalink
LS: Add submitting issues section (#6532)
Browse files Browse the repository at this point in the history
  • Loading branch information
Arcticae authored Oct 29, 2024
1 parent 1053f40 commit c8277d3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions vscode-cairo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,28 @@ please include full logs from both the extension and the language server.
If you feel brave enough, you can try some of the more advanced debugging techniques described in
[CairoLS contribution guidelines][debugging].

## Submitting bugs/issues

If you have a problem that you think should be fixed, please follow steps below:

1. Submit [a new `bug` issue][cairo-new-bug]
2. Choose [`ide` label][cairo-ide-label]
3. Fill out the issue template
4. Attach all relevant screenshots, logs with trace (obtained with steps in [Troubleshooting])
5. Do not forget to attach context like:
- Scarb version (which version or which nightly?), or commit reference (if built locally),
- relevant `Cairo` extension VSCode configuration,
- `Cairo` extension version.

[cairo]: https://www.cairo-lang.org/
[cairo-ide-label]: https://github.com/starkware-libs/cairo/labels/ide
[cairo-new-bug]: https://github.com/starkware-libs/cairo/issues/new?assignees=&labels=bug&projects=&template=01_BUG_REPORT.md&title=bug%3A+
[debugging]: https://github.com/starkware-libs/cairo/blob/main/crates/cairo-lang-language-server/CONTRIBUTING.md#debugging
[discord]: https://discord.gg/QypNMzkHbc
[dojo engine]: https://book.dojoengine.org/
[scarb]: https://docs.swmansion.com/scarb
[scarb-asdf]: https://docs.swmansion.com/scarb/download.html#install-via-asdf
[scarb-dl]: https://docs.swmansion.com/scarb/download.html
[telegram]: https://t.me/cairo_ls_support
[troubleshooting]: #troubleshooting
[vscode-marketplace]: https://marketplace.visualstudio.com/items?itemName=starkware.cairo1

0 comments on commit c8277d3

Please sign in to comment.