Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

39 lines (31 loc) · 1.96 KB
Raw

Contributing to autoref.nvim

Thanks for considering to contribute.

Getting Started

Not sure where to help? Try these:

  • 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](https://github.com/October-Studios/ autoref.nvim/pulls)) to see if some abandoned PR interests you.
  • Feel free to open issues or unfinished PRs for help.
  • 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](https://github.com /mpeterv/luacheck) and run tests with plenary-test. These tests will run on CI. If you want, you can run tests & linter locally with make test & make lint respectively. To run both, use make check.
  • Lua codebase gets formatted with stylua in CI. Formatting can be largely ignored in this case, but if you want to submit formatted PRs, you can run the formatter locally with make format.
  • VimDocs are auto-generated with panvimdoc from README.md. Do not make changes to doc/autoref.txt. Instead, add docs to README or Wiki. The docgen is run in CI as well. 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 in handy, as it will run all aforementioned 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