From 8798e57dce4b2c13734bc78648c2725ea92df095 Mon Sep 17 00:00:00 2001 From: Sergio Alejandro Vargas Date: Wed, 28 Aug 2024 01:00:20 -0500 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..631cef0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +**Make sure to read the following documentation:** + +- [Developing Extensions](https://zed.dev/docs/extensions/developing-extensions) +- [Language Extensions](https://zed.dev/docs/extensions/languages) + + +## Filing issues + +Before reporting an issue, +check [existing issues](https://github.com/JuliaEditorSupport/zed-julia/issues?q=is%3Aissue) +(including closed issues). + +The Julia Zed extension is mostly glue code that defines how Zed should use +tree-sitter and the language server protocol with Julia. Please report issues +in the appropriate issue tracker. + +### tree-sitter integration + +If Zed is not highlighting something properly, +check the queries defined in: [`./languages/julia/*.scm`](./languages/julia/). + +If the issue does not seem to be related to the way queries are defined, +check the [tree-sitter-julia issue tracker](https://github.com/tree-sitter/tree-sitter-julia/issues). + +### Language server integration + +If you find an issue with the language server, +check the [LanguageServer.jl issue tracker](https://github.com/julia-vscode/LanguageServer.jl/issues).