From 31f77498a40202ab9a293e0c3acc0e36acc9acef Mon Sep 17 00:00:00 2001 From: MisanthropicBit Date: Thu, 14 Nov 2024 10:56:00 +0100 Subject: [PATCH] Add contribution guidelines (#31) --- CONTRIBUTING.md | 9 +++++++++ README.md | 5 +++++ 2 files changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7fe4f1e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contributing + +1. Fork this repository. +2. Make changes. +3. Make sure tests and styling checks are passing. + * Run tests by running `./tests/run_tests.sh` in the root directory. Running the tests requires [`plenary.nvim`](https://github.com/nvim-lua/plenary.nvim), [`neotest`](https://github.com/nvim-neotest/neotest), [`nvim-nio`](https://github.com/nvim-neotest/nvim-nio), and [`nvim-treesitter`](https://github.com/nvim-treesitter/nvim-treesitter). You may need to update the paths in `./tests/minimal_init.lua` to match those of your local installations to be able to run the tests. + * Install [stylua](https://github.com/JohnnyMorganz/StyLua) and check styling using `stylua --check lua/ scripts/ tests/ test_files/`. Omit `--check` in order to fix styling. +4. Submit a pull request. +5. Get it approved. diff --git a/README.md b/README.md index 8c5cea2..05a574e 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ neovim as the lua interpreter. - [Debugging tests](#debugging-tests) - [Luarocks and Busted](#luarocks-and-busted) - [Running from the command line](#running-from-the-command-line) +- [Contributing](#contributing) - [FAQ](#faq) @@ -230,6 +231,10 @@ the `"integration"` task in a test file: require("neotest").run.run({ vim.fn.expand("%"), extra_args = { "--run", "integration" } }) ``` +## Contributing + +Thanks for considering to contribute. Please see the instructions [here](/CONTRIBUTING.md). + ## FAQ #### Q: Can I run async tests with neotest-busted?