Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write contributing docs #95

Closed
matklad opened this issue Oct 4, 2018 · 1 comment
Closed

Write contributing docs #95

matklad opened this issue Oct 4, 2018 · 1 comment

Comments

@matklad
Copy link
Member

matklad commented Oct 4, 2018

There are a couple of non-trivial things to explain:

  • how code-generation woks (cargo gen-kinds)
  • how testing works (cargo gen-tests and inline tests)
  • how to run the language server (cargo install-code, RUST_LOG=trace)
  • https://github.com/matklad/rust-analyzer/pull/93 as an example of "how to update grammar"
@aochagavia
Copy link
Contributor

Also interesting to add:

  • How to debug the vscode extension (open the code directory and press F5)

bors bot added a commit that referenced this issue Oct 7, 2018
96: [WIP] Begin to add some contributing docs (#95) r=matklad a=DJMcNab

Currently adds some documentation about `cargo gen-kinds`.

Note that I am unsure of some of the details, such as why `DOT` is in `multi_byte_tokens`, hence the [WIP] tag.

Based on #95.

Co-authored-by: Daniel McNab <36049421+djmcnab@users.noreply.github.com>
@matklad matklad closed this as completed Dec 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants