Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Opinionated crate maintenance

Files to ignore

Minimal .gitignore content:

.idea/
target/
book/
.DS_Store

Code formatting

Minimal rustfmt.toml content:

imports_granularity = "Module"
tab_spaces = 2
max_width = 180

To format Rust code, run:

cargo +nightly fmt

or using taskcmd definition:

  .fmt
    .desc Runs code formatter
    .cmd cargo +nightly fmt

Licenses

To add licenses, run:

magg licenses

Code of conduct

To add a code of conduct, run:

magg code-of-conduct

Topics to cover

  • Code coverage
  • README.md
    • badges
    • licensing
    • overview
    • auto-generating
  • Made by human
  • docs directory
  • manual directory
  • Publishing manual
  • Semantic versioning
  • Changelog