Skip to content

Commit 31f7749

Browse files
Add contribution guidelines (#31)
1 parent 522b5fb commit 31f7749

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
1. Fork this repository.
4+
2. Make changes.
5+
3. Make sure tests and styling checks are passing.
6+
* 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.
7+
* 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.
8+
4. Submit a pull request.
9+
5. Get it approved.

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ neovim as the lua interpreter.
4242
- [Debugging tests](#debugging-tests)
4343
- [Luarocks and Busted](#luarocks-and-busted)
4444
- [Running from the command line](#running-from-the-command-line)
45+
- [Contributing](#contributing)
4546
- [FAQ](#faq)
4647

4748
<!-- panvimdoc-ignore-end -->
@@ -230,6 +231,10 @@ the `"integration"` task in a test file:
230231
require("neotest").run.run({ vim.fn.expand("%"), extra_args = { "--run", "integration" } })
231232
```
232233

234+
## Contributing
235+
236+
Thanks for considering to contribute. Please see the instructions [here](/CONTRIBUTING.md).
237+
233238
## FAQ
234239

235240
#### Q: Can I run async tests with neotest-busted?

0 commit comments

Comments
 (0)