From df4b4d674ff3b4c2169dcd2058fb256f63a3667c Mon Sep 17 00:00:00 2001 From: MarcHamamji Date: Sat, 8 Apr 2023 12:57:19 +0300 Subject: [PATCH] Add more docs for contributing --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b3e0862..48d23e2 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,27 @@ A customizable Neovim plugin to run code inside the editor ## Contribution - If you find that some handlers for a specific language are missing, feel free to open a pull request by adding them in the [lua/runner/handlers/init.lua](lua/runner/handlers/init.lua) file. + This project uses [StyLua](https://github.com/JohnnyMorganz/StyLua) for enforcing code style, and has a [pre-commit](https://pre-commit.com/) hook setup for running it automatically. `runner.nvim` also has a Github Action that runs the linter on every Pull request. If a check doesn't pass on a specific Pull request, please lint the code and commit it again. + + For running them locally, you have to have them installed on your system: + - [StyLua Installation](https://github.com/JohnnyMorganz/StyLua#installation) + - [pre-commit Installation](https://pre-commit.com/#install) + + #### Some useful commands: + + - Install the pre-commit hook + ```bash + pre-commit install + ``` + + - Check for StyLua errors + ```bash + stylua --check lua/ + ``` + + - Fix StyLua errors + ```bash + stylua lua/ + ``` Licensed under the [MIT license](./LICENSE).