git.iko.soy/helix
on f1b9c19 help sign in
helix/docs/CONTRIBUTING.md
68 lines 3.0 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 verbosity)
12 * Want to display the logs in a separate file instead of using the `:log-open` command in your compiled Helix editor? Start your debug version with `cargo run -- --log foo.log` and in a new terminal use `tail -f foo.log`
13- Instead of running a release version of Helix, while developing you may want to run in debug mode with `cargo run` which is way faster to compile
14- Looking for even faster compile times? Give a try to [mold](https://github.com/rui314/mold)
15- If your preferred language is missing, integrating a tree-sitter grammar for
16 it and defining syntax highlight queries for it is straight forward and
17 doesn't require much knowledge of the internals.
19We provide an [architecture.md][architecture.md] that should give you
20a good overview of the internals.
22# Auto generated documentation
24Some parts of [the book][docs] are autogenerated from the code itself,
25like the list of `:commands` and supported languages. To generate these
26files, run
28```shell
29cargo xtask docgen
30```
32inside the project. We use [xtask][xtask] as an ad-hoc task runner.
34To preview the book itself, install [mdbook][mdbook]. Then, run
36```shell
37mdbook serve book
38```
40and visit [http://localhost:3000](http://localhost:3000).
42# Testing
44## Unit tests/Documentation tests
46Run `cargo test --workspace` to run unit tests and documentation tests in all packages.
48## Integration tests
50Integration tests for helix-term can be run with `cargo integration-test`. Code
51contributors are strongly encouraged to write integration tests for their code.
52Existing tests can be used as examples. Helpers can be found in
53[helpers.rs][helpers.rs]. The log level can be set with the `HELIX_LOG_LEVEL`
54environment variable, e.g. `HELIX_LOG_LEVEL=debug cargo integration-test`.
56## Minimum Stable Rust Version (MSRV) Policy
58Helix follows the MSRV of Firefox.
59The current MSRV and future changes to the MSRV are listed in the [Firefox documentation].
61[Firefox documentation]: https://firefox-source-docs.mozilla.org/writing-rust-code/update-policy.html
62[good-first-issue]: https://github.com/helix-editor/helix/labels/E-easy
63[log-file]: https://github.com/helix-editor/helix/wiki/FAQ#access-the-log-file
64[architecture.md]: ./architecture.md
65[docs]: https://docs.helix-editor.com/
66[xtask]: https://github.com/matklad/cargo-xtask
67[mdbook]: https://rust-lang.github.io/mdBook/guide/installation.html
68[helpers.rs]: ../helix-term/tests/test/helpers.rs