neovim-flake/docs/manual/hacking.md

22 lines
1.1 KiB
Markdown
Raw Normal View History

# Hacking nvf {#ch-hacking}
2023-12-09 20:03:58 +01:00
**nvf** is designed for developers as much as it is for the end user. I would like any potential contributor
2023-12-09 20:03:58 +01:00
to be able to propagate their desired changes into the repository without the extra effort. As such, below are guides
(and guidelines) to streamline the contribution process and ensure that your valuable input seamlessly integrates
into **nvf**'s development without leaving question marks in your head.
2023-12-09 20:03:58 +01:00
This section is mainly directed towards those who wish to contribute code into **nvf**. If you wish to instead
2023-12-09 20:03:58 +01:00
report a bug or discuss a potential feature implementation, first look among the
already [open issues](https://github.com/notashelf/nvf/issues) and if no matching issue exists you may open
a [new issue](https://github.com/notashelf/nvf/issues/new) and describe your problem/request. While creating an
2023-12-09 20:03:58 +01:00
issue, please try to include as much information as you can, ideally also include relevant context in which an issue
occurs or a feature should be implemented.
```{=include=} sections
hacking/getting-started.md
hacking/guidelines.md
hacking/testing.md
hacking/keybinds.md
hacking/additional-plugins.md
```