rob
/
lualine.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Mention that nvim-web-devicons is required for proper testing (#856)

This commit is contained in:
zappolowski 2022-10-22 12:49:30 +02:00 committed by GitHub
parent aa357acdae
commit a4bc56f6fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -29,10 +29,10 @@ Good luck!
*Let's introduce you to the tools we use.* *Let's introduce you to the tools we use.*
- Your PR needs to pass tests & linter. We lint our codebase with [luacheck](https://github.com/mpeterv/luacheck) - Your PR needs to pass tests & linter. We lint our codebase with [luacheck](https://github.com/mpeterv/luacheck)
and run tests with [plenary-test](https://github.com/nvim-lua/plenary.nvim) and run tests with [plenary-test][plenary.nvim] these will be ran on CI. If you want you can run tests & linter
these will be ran on CI. If you want you can run tests & linter locally with locally with `make test` & `make lint` respectively. Or `make check` to run both linter & tests. For running
`make test` & `make lint` respectively. Or `make check` to run both linter & tests. tests you'll have to make sure lualine.nvim, [plenary.nvim][plenary.nvim] and
For running tests you'll have to make sure both lualine.nvim and plenery.nvim are in same directory. [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) are in same directory.
- Lua codebase gets formatted with [stylua](https://github.com/JohnnyMorganz/StyLua) in CI. - Lua codebase gets formatted with [stylua](https://github.com/JohnnyMorganz/StyLua) in CI.
So you can ignore formatting. But if you want to submit formatted So you can ignore formatting. But if you want to submit formatted
PR you can run formatter locally with `make format`. PR you can run formatter locally with `make format`.
@ -46,3 +46,5 @@ Good luck!
& [luacov-console](https://github.com/spacewander/luacov-console) installed for that. & [luacov-console](https://github.com/spacewander/luacov-console) installed for that.
If you want luacov's detailed report files, run the command with the `NOCLEAN` env set. If you want luacov's detailed report files, run the command with the `NOCLEAN` env set.
For example `NOCLEAN=1 make testcov` For example `NOCLEAN=1 make testcov`
[plenary.nvim]: https://github.com/nvim-lua/plenary.nvim