Skip to content

Commit

Permalink
docs: make sure contributing docs are up to date
Browse files Browse the repository at this point in the history
  • Loading branch information
ckipp01 committed Jan 30, 2025
1 parent a492be2 commit 7f84763
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@ off to make sure they aren't better there:
- `git clone [email protected]:scalameta/nvim-metals.git`
- Load up the plugin to test what you're doing. There are basically two ways
to do this:
1. You can directly use the plugin from your filesystem using
[`packer`](https://github.com/wbthomason/packer.nvim) as outlined in
the docs. This will basically just be `use '~/your-path-to/nvim-metals'`.
1. You can directly use the plugin from your filesystem using whativer
system your plugin manager has to use a local plugin.
2. You can also just manually add the plugin to your `runtimepath` with an
alias. For example you could have something like `nvim --cmd 'set rtp+=/your-path-to/nvim-metals`.
- Make sure to branch off main to send in your changes. This allows the
Expand All @@ -64,13 +63,11 @@ After installed you can just use the commands in the Makefile to use them.

## Testing

You can find the tests that exist for `nvim-metals` in the `tests/` directory.
These are ran using the
[`plenary.test_harness`](https://github.com/nvim-lua/plenary.nvim/tree/master#plenarytest_harness).
It's useful to give the plenary page a read about this to better understand what
is happening. However, before running the tests locally make sure to run `make
local-test-setup` which will clone some repos used for testing. After this you
can use `make test`.
You can find the tests that exist for `nvim-metals` in the `spec/` directory.
These are ran using [nlua](https://github.com/mfussenegger/nlua). You'll want to
read the installation instructions over there. However, before running the tests
locally make sure to run `make local-test-setup` which will clone some repos
used for testing. After this you can use `make test`.

## Other Libraries / Integrations

Expand Down

0 comments on commit 7f84763

Please sign in to comment.