Mirrors/LunarVim
Mirrors/LunarVim
1
0
Fork 0
mirror of https://github.com/LunarVim/LunarVim.git synced 2024-09-20 10:35:08 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Abouzar Parvan 2021-07-21 00:33:03 +04:30 committed by GitHub
parent 0064b446a0
commit 87c4ff915d
WARNING! Although there is a key with this ID in the database it does not verify this commit! This commit is SUSPICIOUS.
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -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
3. Install [shfmt](https://github.com/mvdan/sh#shfmt)
## Some Guidelines
### 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).
* Use snake_case
* 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