falsepattern/ZigBrains
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

docs: Clarify PSI tree usage in CONTRIBUTING.md

Browse source
This commit is contained in:
FalsePattern 2023-08-09 09:06:40 +02:00 • committed by FalsePattern
parent 6385be94dc
commit 41ef35d3af
Signed by: falsepattern
GPG key ID: FDF7126A9E124447
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -3,5 +3,7 @@ For now this project is still pretty small, but here are some general guidelines
- This project ships with a code style config in .idea, your IDE should automatically apply it when you pull the repo. - This project ships with a code style config in .idea, your IDE should automatically apply it when you pull the repo.
When making pull requests, please try to keep to this style as much as possible. When making pull requests, please try to keep to this style as much as possible.
- Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), and scope as much as you can. - Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), and scope as much as you can.
- One of the core ideas of this project is *not* using the IntellIJ parser/tokenizer. If you want to work with that - The project has support for the PSI tree, but try to keep "intelligent" behaviour out of it, all code inspection and
system, check out [intellij-zig](https://github.com/intellij-zig/intellij-zig). other semantics-aware help should come from ZLS where possible.
- Generally, if the answer to "Can i write some glue code that can get this info from ZLS?" is YES, do not use the PSI
tree.