rob/lualine.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
lualine.nvim/CONTRIBUTING.md
Daemon b61afc44e6
docs: cleanup formatting and comment typos (#696) 
* docs: fix typo in component notice

* refactor: rename typo param 'pattern'

* docs: fix comments typos across project files

Cleanup misspellings and wording in comment lines.

* docs: improve readability of `CONTRIBUTING.md`

* docs: improve readability of `README.md`

- Minor typos
- Clarify information
- Separate sections from paragraphs

* docs: add newline below headers in `THEMES.md`

Aim's to be consistent with other documents.

* docs: fix unname tabpage command reference

* docs: reword 'directly bused' for `setup_theme()`

* docs: fix extra indent in contribution list

* docs: more separation in readme/tabs, remove extra backtick

* docs: further improve wording for `setup_theme`

* docs: improve wording for `setup` function

* docs: missing underscore in lualine/config
2022-05-30 20:25:05 +06:00

2.9 KiB
Raw Blame History

Contributing to lualine.nvim

Thanks for considering to contribute.

Getting started

If you're not sure where to help? You can try these:

  • You can look at the currently open issues to see if some bug needs fixing or for cool feature ideas.
    You should also look at currently open PRs (Pull requests) to see if some abandoned PR interests you.
    We could really use some help with tests & docs they are currently lacking :)
  • You can add an exciting new component, extension or theme. Note: Currently we aren't adding regular colorscheme based themes. We think they make more sense with colorschemes as they tend not to get updated once added here. But if you have some unique themes idea like auto or pywal feel free to open an PR or issue.
  • Feel free to open issues or unfinished PRs for help. I'd actually recommend you to open an issue first for bigger PRs to discuss the feature with a maintainer beforehand. That way you can know if the feature is likely to be accepted or not before you get started. You'll get recommendation and help with implementation specially if you show willingness to implement it yourself.
  • Do add tests and docs for your changes.

Good luck!

Developer tools

Let's introduce you to the tools we use.

  • Your PR needs to pass tests & linter. We lint our codebase with luacheck and run tests with plenary-test these will be ran on CI. If you want you can run tests & linter locally with 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.
  • Lua codebase gets formatted with stylua in CI. So you can ignore formatting. But if you want to submit formatted PR you can run formatter locally with make format.
  • VimDocs are auto generated with panvimdoc from README.md. So don't make changes to doc/lualine.txt . Instead add your docs to README or Wiki. 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 installed.
  • 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'll need to have luacov & luacov-console installed for that. If you want luacov's detailed report files, run the command with the NOCLEAN env set. For example NOCLEAN=1 make testcov