on master help sign in
Expand contributing docs (#5967)
31b0c75Mathieu Agopian
docs/CONTRIBUTING.md+4−1
@@ -8,7 +8,10 @@ Some suggestions to get started:
8- Help with packaging on various distributions needed!
8- Help with packaging on various distributions needed!
9- To use print debugging to the [Helix log file][log-file], you must:
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!")`)
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)
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)
12- If your preferred language is missing, integrating a tree-sitter grammar for
15- 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
16 it and defining syntax highlight queries for it is straight forward and
14 doesn't require much knowledge of the internals.
17 doesn't require much knowledge of the internals.