linebender/parley

Add the linebender lint set

Open

#108 opened on Aug 25, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (92 forks)github user discovery
good first issue

Repository metrics

Stars
 (620 stars)
PR merge metrics
 (PR metrics pending)

Description

We should add a standardized set of rustc lints and clippy lints to all our projects. If we raise MSRV to 1.74, we can add them directly to Cargo.toml.

See zulip discussion for what our lint set should be. See https://github.com/linebender/peniko/pull/47/ for our current lint set.

Aside from the Cargo.toml lints, we should also add the following annotation to our crate root:

#![warn(clippy::print_stdout, clippy::print_stderr, clippy::dbg_macro)]

(We don't want a workspace-level lints for those because we want to tolerate prints in tests and examples.)

See this zulip thread for details.

We should add the following annotation at the crate roots:

We should also remove leftover prints, if any, or give them an opt-out.

Contributor guide

Research direction
Review the referenced PR (peniko#47) and Zulip discussion to understand the proposed lint set, then add the same lints to this crate's Cargo.toml and crate root.
Tech stack
rust
Domain
backend
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60