diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbb6075..46a3f0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,10 @@ -# Tips - -## Nerd Fonts +# Hacking on i3stat -Nerd Font icons come in two variants. If the font was called "A", the the variants are: - -* "A Nerd Font" -* "A Nerd Font Mono" +* All new development is done on the `next` branch! Don't target `master`! +* Run the tests with `just` (not via `cargo`) +* Read the rest of this file! -The one with the "Mono" suffix has all the icons 'squashed' into a single monospace character's width. -This is a compatibility for programs that don't support double-width characters, but does make some of the icons appear too small. - -Unfortunately, as far as I can tell, i3's statusbar doesn't properly support the double-width character icons. -So, if the normal font is used, sometimes the icons appear to overlap neighbouring characters. +# Tips ## Debugging integration tests @@ -26,6 +19,19 @@ It's a cheaper method of keeping immutable data around without having to realloc Since mutating the data isn't necessary, this can just point the the existing data and we get cheap clones. See https://www.youtube.com/watch?v=A4cKi7PTJSs for a good explanation. +## Nerd Fonts + +Nerd Font icons come in two variants. If the font was called "A", the the variants are: + +* "A Nerd Font" +* "A Nerd Font Mono" + +The one with the "Mono" suffix has all the icons 'squashed' into a single monospace character's width. +This is a compatibility for programs that don't support double-width characters, but does make some of the icons appear too small. + +Unfortunately, as far as I can tell, i3's statusbar doesn't properly support the double-width character icons. +So, if the normal font is used, sometimes the icons appear to overlap neighbouring characters. + # Creating the next release All new development is done on the `next` branch. When it's time to make a release, a PR is created to `master`.