Skip to content

Commit

Permalink
Add note about LuaLS to CONTRIBUTING guide
Browse files Browse the repository at this point in the history
  • Loading branch information
epwalsh committed Sep 22, 2023
1 parent 3df8a3b commit 9a45ebc
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

Thanks for considering contributing! Please read this document to learn the various steps you should take before submitting a pull request.

## Local development

If you're using the [Lua Language Server](https://luals.github.io) (LuaLS) you'll probably want to add `plenary.nvim` as a workspace library since we rely heavily on plenary throughout the codebase. You can do this by adding a `.luarc.json` configuration file that looks like this:

```json
{
"$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
"workspace.library": ["~/.local/share/nvim/lazy/plenary.nvim/"],
"runtime.version": "Lua 5.1"
}
```

Make sure that the path there to plenary is correct for you.

## Keeping the CHANGELOG up-to-date

This project tries hard to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), and we maintain a [`CHANGELOG`](https://github.com/epwalsh/obsidian.nvim/blob/main/CHANGELOG.md) with a format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
Expand Down

0 comments on commit 9a45ebc

Please sign in to comment.