From 7a10b18c3e8d2c4865c06a52389894d0c3e9ab42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20R=C3=BC=C3=9Fler?= Date: Wed, 10 Jul 2024 18:50:08 +0200 Subject: [PATCH 1/2] Mention cargo-diet and sort in README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b6e9b19d89..b6362f50a81 100644 --- a/README.md +++ b/README.md @@ -324,7 +324,7 @@ Project non-goals can change over time as we learn more, and they can be challen If what you have seen so far sparked your interest to contribute, then let us say: We are happy to have you and help you to get started. -We recommend running `just test check-size` during the development process to assure CI is green before pushing. +We recommend running `just test check-size` during the development process to assure CI is green before pushing. Make sure to have [cargo-diet][cargo-diet] installed before you run `just check-size`. When running tests, make sure to have `LC_ALL=C` set in order to make `sort` which is used in some of the tests behave as expected. A backlog for work ready to be picked up is [available in the Project's Kanban board][project-board], which contains instructions on how to pick a task. If it's empty or you have other questions, feel free to [start a discussion][discussions] or reach out to @Byron [privately][keybase]. @@ -335,6 +335,7 @@ For additional details, also take a look at the [collaboration guide]. [project-board]: https://github.com/Byron/gitoxide/projects [discussions]: https://github.com/Byron/gitoxide/discussions [keybase]: https://keybase.io/byronbates +[cargo-diet]: https://crates.io/crates/cargo-diet ### Getting started with Video Tutorials From a32c462969377f973e7203e66d7ead620f9ff22b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20R=C3=BC=C3=9Fler?= Date: Thu, 11 Jul 2024 13:14:52 +0200 Subject: [PATCH 2/2] Don't mention `check-size` in README Turn comment into code in `journey.sh`. --- README.md | 2 +- tests/journey.sh | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b6362f50a81..4e986796616 100644 --- a/README.md +++ b/README.md @@ -324,7 +324,7 @@ Project non-goals can change over time as we learn more, and they can be challen If what you have seen so far sparked your interest to contribute, then let us say: We are happy to have you and help you to get started. -We recommend running `just test check-size` during the development process to assure CI is green before pushing. Make sure to have [cargo-diet][cargo-diet] installed before you run `just check-size`. When running tests, make sure to have `LC_ALL=C` set in order to make `sort` which is used in some of the tests behave as expected. +We recommend running `just test` during the development process to assure CI is green before pushing. A backlog for work ready to be picked up is [available in the Project's Kanban board][project-board], which contains instructions on how to pick a task. If it's empty or you have other questions, feel free to [start a discussion][discussions] or reach out to @Byron [privately][keybase]. diff --git a/tests/journey.sh b/tests/journey.sh index 6950711f757..63771e415fb 100755 --- a/tests/journey.sh +++ b/tests/journey.sh @@ -29,6 +29,10 @@ SUCCESSFULLY=0 WITH_FAILURE=1 WITH_CLAP_FAILURE=2 +# `sort` which is used in some of the snapshots tests depends on the value of +# `LC_ALL` when it comes to the order of dotfiles and non-dotfiles. It sorts +# differently when `LC_ALL=C` vs. when it is not set at all. +export LC_ALL=C set-static-git-environment