aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authordundargoc <33953936+dundargoc@users.noreply.github.com>2022-08-02 12:32:57 +0200
committerGitHub <noreply@github.com>2022-08-02 12:32:57 +0200
commit8ce7e7409f10f0a90ed8aa3f6f179c4b5d44eacb (patch)
treedc7bcb32002aa0866cb6a7c6fe72dc3a8fc90979 /CONTRIBUTING.md
parentc223875a65dd703e42956e064239369817faa0b2 (diff)
downloadrneovim-8ce7e7409f10f0a90ed8aa3f6f179c4b5d44eacb.tar.gz
rneovim-8ce7e7409f10f0a90ed8aa3f6f179c4b5d44eacb.tar.bz2
rneovim-8ce7e7409f10f0a90ed8aa3f6f179c4b5d44eacb.zip
build: add formatting targets for c and lua files (#19488)
The targets will only format files that have been changed in current branch compared to the master branch. This includes unstaged, staged and committed files. Add following make and cmake targets: formatc - format changed c files formatlua - format changed lua files format - run formatc and formatlua Remove scripts/uncrustify.sh as this deprecates it.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e26d0d63c5..17622fa33a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -218,6 +218,11 @@ You can lint a single file (but this will _not_ exclude legacy errors):
### Style
+- You can format files by using:
+```
+ make format
+```
+This will format changed Lua and C files with all appropriate flags set.
- Style rules are (mostly) defined by `src/uncrustify.cfg` which tries to match
the [style-guide]. To use the Nvim `gq` command with `uncrustify`:
```