Skip to content

Commit

Permalink
Add contribution guidelines (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
MisanthropicBit authored Nov 14, 2024
1 parent 522b5fb commit 31f7749
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- panvimdoc-ignore-end -->
Expand Down Expand Up @@ -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?
Expand Down

0 comments on commit 31f7749

Please sign in to comment.