docs/CONTRIBUTING.md · helix

on 0b8a00a help sign in

helix/docs/CONTRIBUTING.md

37 lines 1.6 kB history raw

1# Contributing

3Contributors are very welcome! **No contribution is too small and all contributions are valued.**

5Some suggestions to get started:

7- You can look at the [good first issue][good-first-issue] label on the issue tracker.

8- Help with packaging on various distributions needed!

9- To use print debugging to the [Helix log file][log-file], you must:

10 * Print using `log::info!`, `warn!`, or `error!`. (`log::info!("helix!")`)

11 * Pass the appropriate verbosity level option for the desired log level. (`hx -v <file>` for info, more `v`s for higher severity inclusive)

12- If your preferred language is missing, integrating a tree-sitter grammar for

13 it and defining syntax highlight queries for it is straight forward and

14 doesn't require much knowledge of the internals.

16We provide an [architecture.md][architecture.md] that should give you

17a good overview of the internals.

19# Auto generated documentation

21Some parts of [the book][docs] are autogenerated from the code itself,

22like the list of `:commands` and supported languages. To generate these

23files, run

25```shell

26cargo xtask docgen

27```

29inside the project. We use [xtask][xtask] as an ad-hoc task runner and

30thus do not require any dependencies other than `cargo` (You don't have

31to `cargo install` anything either).

33[good-first-issue]: https://github.com/helix-editor/helix/labels/E-easy

34[log-file]: https://github.com/helix-editor/helix/wiki/FAQ#access-the-log-file

35[architecture.md]: ./architecture.md

36[docs]: https://docs.helix-editor.com/

37[xtask]: https://github.com/matklad/cargo-xtask