Thanks for wanting to help out with nvim-orgmode, we appreciate the effort!
📣 Please always make a quick search in our issue-tracker before reporting anything. If the bug/feature has already been reported, continue the conversation on the existing issue.
We distinguish between core (part of orgmode) and non-core features.
The former will be prioritized. Bugs get the highest priority.
If you're reporting a core feature, please be sure to provide a link that describes it. There are several places where features could be documented, have a look at these resources. The more info you provide the better!
If you spot something missing in our docs, don't hesitate making a PR. The wiki can be edited freely.
You can take a look at our feature completeness list and see if any of the missing features catch your interest.
If you prefer working on an issue that has been reported, please leave a comment voicing your interest.
Please document any new code you add with emmylua annotations. Feel free to add annotations/docs to any existing functions integral to your PR that are missing them.
To run tests, plenary.nvim and nvim-treesitter must be present in the nvim-orgmode directory:
git clone https://github.com/nvim-treesitter/nvim-treesitter
git clone https://github.com/nvim-lua/plenary.nvim
make test
Formatting is done via StyLua. To format everything run:
make format
Parsing is done via builtin treesitter parser and the tree-sitter-org grammar.