Skip to content

Mention cargo-diet and sort in README #1449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 11, 2024
Merged

Mention cargo-diet and sort in README #1449

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a10b18
Mention cargo-diet and sort in README
cruessler Jul 10, 2024
a32c462
Don't mention `check-size` in README
cruessler Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand All @@ -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

Expand Down