docs/CONTRIBUTING.md · helix

on 4ef6621 help sign in

helix/docs/CONTRIBUTING.md

52 lines 2.3 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# Integration tests

35Integration tests for helix-term can be run with `cargo integration-test`. Code

36contributors are strongly encouraged to write integration tests for their code.

37Existing tests can be used as examples. Helpers can be found in

38[helpers.rs][helpers.rs]. The log level can be set with the `HELIX_LOG_LEVEL`

39environment variable, e.g. `HELIX_LOG_LEVEL=debug cargo integration-test`.

41## Minimum Stable Rust Version (MSRV) Policy

43Helix follows the MSRV of Firefox.

44The current MSRV and future changes to the MSRV are listed in the [Firefox documentation].

46[Firefox documentation]: https://firefox-source-docs.mozilla.org/writing-rust-code/update-policy.html

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

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

49[architecture.md]: ./architecture.md

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

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

52[helpers.rs]: ../helix-term/tests/test/helpers.rs