mirror of
https://github.com/LunarVim/LunarVim.git
synced 2024-09-20 18:45:08 +02:00
Update CONTRIBUTING.md
This commit is contained in:
parent
0064b446a0
commit
87c4ff915d
1 changed files with 12 additions and 0 deletions
|
@ -21,6 +21,8 @@ One of the best ways to begin contributing in a meaningful way is by helping fin
|
||||||
|
|
||||||
2. Copy `utils/.stylua.toml` into the LunarVim root directory
|
2. Copy `utils/.stylua.toml` into the LunarVim root directory
|
||||||
|
|
||||||
|
3. Install [shfmt](https://github.com/mvdan/sh#shfmt)
|
||||||
|
|
||||||
## Some Guidelines
|
## Some Guidelines
|
||||||
|
|
||||||
### Git Commit Messages
|
### Git Commit Messages
|
||||||
|
@ -40,6 +42,16 @@ ex: (feature|bugfix|hotfix)/what-my-pr-does
|
||||||
All lua code is formatted with [Stylua](https://github.com/JohnnyMorganz/StyLua).
|
All lua code is formatted with [Stylua](https://github.com/JohnnyMorganz/StyLua).
|
||||||
* Use snake_case
|
* Use snake_case
|
||||||
* Avoid platform-dependent code
|
* Avoid platform-dependent code
|
||||||
|
```bash
|
||||||
|
stylua --config-path ./utils/.stylua.toml -c .
|
||||||
|
```
|
||||||
|
|
||||||
|
All shell code is formatted according to [Google Shell Style Guide](https://google.github.io/styleguide/shellguide.html)
|
||||||
|
* use two spaces instead of tabs
|
||||||
|
```bash
|
||||||
|
shfmt -i 2 -ci -l -d .
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Communication
|
## Communication
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue