Skip to content

Documentation: mention nixf-tidy in contributing guide #332695

@flokli

Description

@flokli

Problem

Since a while, GH actions runs nixf-tidy to detect useless rec and unused variables.

While I'm generally in favor of this, the output sometimes lacks detail, and it's desirable to run some of the checks locally, to prevent spamming PR reviewers (and CI).

However, nixf-tidy and its usage is very sparsely documented.

nix-community/nixd#446 seems to have introduced it to nixd, yet there's neither a --help handler, nor documentation about the tool anywhere

Proposal

document nixf-tidy in both nixd repo, as well in the general nixpkgs contributing guideline and docs.

Checklist


Add a 👍 reaction to issues you find important.

Metadata

Metadata

Labels

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions