Skip to content

Minor repo cleanup proposal #308

@nyurik

Description

@nyurik

Hi, thanks for the awesome tool! I use it regularly, and would be happy to contribute. Would it be ok to update the repo a bit to bring it inline with the common rust projects, e.g. with the standard code formatting and clippy validation? I suspect many of these will also help onboard this into cargo in the future. Some of the ideas:

  • run cargo fmt --all -- this ensures every contributor uses the same standard rust format, and minimizes the diffs
  • run cargo clippy and fix all issues -- i discovered many bugs with this in numerous projects
  • introduce [lints] section to Cargo.toml to improve code quality
  • introduce MSRV
  • add clippy enforcement to CI
  • enable https://pre-commit.ci/ to automatically fix minor formatting and other text issues without the user involvement (i.e. auto-fix all PRs)
  • enable codecoverage like https://codecov.io and upload coverage results there
  • ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions