Skip to content

Commit 4f7f93c

Browse files
authored
Update CONTRIBUTING.md
1 parent d4db418 commit 4f7f93c

1 file changed

Lines changed: 30 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
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.
44

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+
530
## Commit Convention
631

732
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
4570

4671
### Annotations
4772

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.
4974

5075
Annotations are critical for readability, code completion, error checking, and automatic generation of class documentations.
5176

@@ -110,7 +135,7 @@ You are free to use any style you want, except in these cases:
110135
SomeFunc(param1, param2, param3, param4, param5, param6, param7, param8, param9, ...)
111136
```
112137

113-
- Preferred (Pythonic) style:
138+
- Preferred *(Pythonic)* style:
114139

115140
```lua
116141
SomeFunc(
@@ -131,7 +156,7 @@ You are free to use any style you want, except in these cases:
131156

132157
- Always try to use guarded if statements when applicable.
133158

134-
- Example:
159+
- Bad Example:
135160

136161
```lua
137162
local cond_1 = false
@@ -256,7 +281,8 @@ The project is organized by responsibility rather than feature size. Folders def
256281
│ │ # - If your UI requires more than one file, group them in a subfolder.
257282
│ │ # - If you have one large file doing a multitude of things, split it into multiple files and group them in a subfolder.
258283
│ │
259-
│ ├─ lib/ # Contains project libraries and commands: API extensions, ImGui extensions, Lua standard library extensions, global utilities, etc.
284+
│ ├─ lib/ # Serves as the project's library folder.
285+
│ │ ├─ extensions/ # API and standard library extensions.
260286
│ │ └─ translations/ # This is where translation files, supported locales, and the translations hash map are stored.
261287
│ │
262288
│ ├─ modules/ # Contains custom modules such as native wrappers, game entity abstractions, YimMenu API wrappers, and higher-level gameplay utilities.

0 commit comments

Comments
 (0)