Skip to content

Latest commit

 

History

History
19 lines (10 loc) · 1.49 KB

CONTRIBUTING.adoc

File metadata and controls

19 lines (10 loc) · 1.49 KB

Contributing to Conjure

Conjure is a Neovim specific Lua plugin written in Fennel and compiled to Lua by Aniseed.

It’s developed using itself which leads to an extremely tight feedback loop. This makes it easier to move fast without breaking things.

To work on Conjure you’ll first need to clone the repository and execute make deps, then point your plugin manager at the directory.

You should checkout the develop branch and make all changes there as well as target your pull request at the develop branch.

Now you can open up Conjure’s source files (ending in .fnl) and evaluate them as you would any other language with Conjure, see :help conjure.

Your changes and evaluations only apply to the in memory copy of Conjure, use make compile to persist the changes as files in the lua directory. I commit these alongside my Fennel changes so each commit lines up with the Fennel and corresponding Lua changes.

Once you’re happy with your changes, you can (maybe) write some tests and execute them with make test. CircleCI will also run them for you.

You can run scripts/docker.sh to drop into a fresh Ubuntu based Neovim environment with Conjure pre-installed from your working directory. This can be used to verify your changes in a clean room environment.

If you’d like to contribute or are having issues please don’t hesitate to get in touch with me (Olical / Oliver Caldwell) on twitter, email or Clojurians Slack.