You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+30-4Lines changed: 30 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,31 @@
2
2
3
3
Thank you for considering contributing to this project! It's people like you that make the open source community a great place to learn, inspire, and create.
4
4
5
+
## Language Server
6
+
7
+
A modified version of [YimLLS](https://github.com/YimMenu-Lua/YimLLS) can be found [here](https://github.com/xesdoog/YimLLSX). Fork the repo and point to its path in your workspace to have type hints for everything the project adds to the vanilla API.
8
+
9
+
- Example `.code-workspace` or `settings.json` file:
10
+
11
+
```JSON
12
+
{
13
+
"folders": [
14
+
{
15
+
"path": "."
16
+
},
17
+
],
18
+
"settings": {
19
+
"Lua.workspace.checkThirdParty": false,
20
+
"Lua.workspace.library": [
21
+
"MyDrive:\\Path\\To\\YimLLSX"
22
+
],
23
+
"Lua.runtime.builtin": {
24
+
"debug": "disable",
25
+
},
26
+
}
27
+
}
28
+
```
29
+
5
30
## Commit Convention
6
31
7
32
These are recommended, but not enforced yet. We follow slightly similar commit guidelines to [YimMenu](https://github.com/Mr-X-GTA/YimMenu/blob/master/CONTRIBUTING.md):
@@ -45,7 +70,7 @@ These are recommended, but not enforced yet. We follow slightly similar commit g
45
70
46
71
### Annotations
47
72
48
-
Annotate all enums, classes, and class methods using [LuaLS](https://luals.github.io/wiki/annotations/)'s style.
73
+
Annotate all enums, classes, and class methods following the [Lua Language Server](https://luals.github.io/wiki/annotations/) standard.
49
74
50
75
Annotations are critical for readability, code completion, error checking, and automatic generation of class documentations.
51
76
@@ -110,7 +135,7 @@ You are free to use any style you want, except in these cases:
0 commit comments