Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 1.54 KB
Raw

Contributing to neotest-java

If you are here it means you are interested in contributing. Thank you for your help! 🎊

📥 Pull Requests

If you are considering to open a pull request for a little change, feel free do it straight forward. For larger changes, it is a good idea to open an issue first describing the feature idea or bug.

For the PRs to succeed and be merged you are expected to:

  • have read this doc
  • run the formatter before every commit
  • to avoid duplicated work, open a draft PR as soon as you get to work

🔌 Set up

Required dependencies for contributors

You will need to have installed:

  • Java JDK 17 or 21
  • This list of commands available in your terminal:
    • stylua
    • make
    • git

First build

The first step to setup your enviroment is to type:

make

This command will:

  1. clone neotest, plenary and nvim-treesitter
  2. install the java parser for nvim-treesitter
  3. build the java projects (it is expected to have some failing test)
  4. run neotest-java tests

Running tests

A. Using neotest-plenary.

Note: For the moment, you will need to specify the path to .../neotest-java/tests/testrc.vim in the neotest-plenary configuration. See nvim-neotest/neotest-plenary#13

B. From terminal

  • Run all tests (for lua changes): 
    make test
  • Run all tests (for lua and java changes): 
    make clean && make
  • Run a test file: 
    ./scripts/test [path-to-test-file]