rust-lang / rust-lang/rust-clippy

Check for `// SPDX-License-Identifier: XXX` in all source files

Open
#11,663 7 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-lint
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

What it does

Some projects require a license be specified in all source files. Clippy could check for this, just make sure the comment is present as the first line.

By default it could just check for presence of the line in all files and verify it is a valid license with the help of the crate spdx. A config option could specify allowed or required licenses.

Advantage

No response

Drawbacks

No response

Example
// SPDX-License-Identifier: MIT OR Apache-2.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points; begin by locating Clippy's lint implementation and its configuration conventions. Done means checking all source files for a first-line SPDX comment, validating licenses with the spdx crate, and supporting allowed or required license configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.