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

doc: update some wording in CONTRIBUTING.md

This commit is contained in:
shadmansaleh 2022-02-02 19:12:36 +06:00
parent 0d0ea77e1a
commit aed7f25461
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -9,9 +9,9 @@ You're not sure where to help. You can try these
if some abandoned pr interests you<br> if some abandoned pr interests you<br>
*We could really use some help with tests & docs they are currently lacking :)* *We could really use some help with tests & docs they are currently lacking :)*
- You can add exciting new component, extension or theme. - You can add exciting new component, extension or theme.
(Note: Currently we aren't accepting regular colorscheme based themes. Note: Currently we aren't adding regular colorscheme based themes.
We think they make more sense with colorschemes as they tend not to get We think they make more sense with colorschemes as they tend not to get
updated once added hete. But if you have some unique themes idea like [auto](https://github.com/nvim-lualine/lualine.nvim/blob/master/THEMES.md#auto) or [pywal](https://github.com/nvim-lualine/lualine.nvim/blob/master/THEMES.md#pywal)) feel free to open an issue or pr. updated once added here. But if you have some unique themes idea like [auto](https://github.com/nvim-lualine/lualine.nvim/blob/master/THEMES.md#auto) or [pywal](https://github.com/nvim-lualine/lualine.nvim/blob/master/THEMES.md#pywal) feel free to open an pr or issue.
- Feel free to open issues or unfinished pr for help. - Feel free to open issues or unfinished pr for help.
I'd actually recommend you to open an issue first for bigging prs to discuss I'd actually recommend you to open an issue first for bigging prs to discuss
the feature with maintainer beforehand. That way you'll can know if the the feature with maintainer beforehand. That way you'll can know if the
@ -31,15 +31,15 @@ Good luck.
`make test` & `make lint` respectively. Or `make check` to run both linter & tests. `make test` & `make lint` respectively. Or `make check` to run both linter & tests.
For running tests you'll have to make sure both lualine.nvim and plenery.nvim are in same directory. For running tests you'll have to make sure both lualine.nvim and plenery.nvim 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 if you want. 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`.
- VimDocs are auto generated with [panvimdoc](https://github.com/kdheepak/panvimdoc) from README.md. - VimDocs are auto generated with [panvimdoc](https://github.com/kdheepak/panvimdoc) from README.md.
So don't make changes to doc/lualine.txt . Instead add your docs to README or Wiki. So don't make changes to doc/lualine.txt . Instead add your docs to README or Wiki.
The docgen in ran by CI. If you want to run it locally you can do so The docgen in ran by CI too. If you want to run it locally you can do so
with `make docgen`. Note: you'll need to have [pandoc](https://github.com/jgm/pandoc) installed. with `make docgen`. Note: you'll need to have [pandoc](https://github.com/jgm/pandoc) installed.
- `make precommit_check` can come quite handy it'll run all the above mentioned tools - `make precommit_check` can come quite handy it'll run all the above mentioned tools
- You can check our test coverage with `make testcov`. - You can check our test coverage with `make testcov`.
You'll need to have [luacov](https://github.com/keplerproject/luacov) You'll need to have [luacov](https://github.com/keplerproject/luacov)
& [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 the luacovs detailed report files run the command with NOCLEAN env set. If you want the luacovs detailed report files run the command with NOCLEAN env set.
like `NOCLEAN=1 make testcov` For example `NOCLEAN=1 make testcov`