Skip to content

Commit 419d173

Browse files
committed
Add note on getting involved to the README
People keep asking me about this 😅
1 parent 3dcc960 commit 419d173

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1205,3 +1205,22 @@ indentation from the syntax tree? Source formatting involves a big pile of
12051205
heuristics to get something which "looks nice"... and ML systems have become
12061206
very good at heuristics. Also, we've got huge piles of training data — just
12071207
choose some high quality, tastefully hand-formatted libraries.
1208+
1209+
# Getting involved
1210+
1211+
For people who want to help improve Julia's error messages by contributing to
1212+
JuliaSyntax, I'd suggest looking through the issue list at
1213+
https://github.com/JuliaLang/JuliaSyntax.jl/issues and choosing a small issue
1214+
or two to work on to familiarize yourself with the code. Anything marked with
1215+
the labels `intro issue` or `bug` might be a good place to start.
1216+
1217+
Also watching the 2022 JuliaCon talk and reading this document is probably good
1218+
for an overview.
1219+
1220+
As of March 2023, we've got really good positional tracking within the source,
1221+
but JuliaSyntax really needs a better system for parser recovery before the
1222+
errors are really nice. This requires some research. For example, you could
1223+
read up on how rust-analyzer does recovery, or rslint - both these are
1224+
event-based recursive decent parsers with similar structure to JuliaSyntax
1225+
(though in Rust). I also want to investigate whether we can do data-driven
1226+
parser recovery using an ML technique. But again, this is a research project.

0 commit comments

Comments
 (0)