orhun/git-cliff

Support searching in .config folder

Open

#1,182 opened on Jun 20, 2025

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Rust (308 forks)auto 404
feature/requestgood first issue

Repository metrics

Stars
 (12,040 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

https://dot-config.github.io/ extends the XDG standard to have a .config folder inside your project folder. It would be nice to be able to move the cliff.toml file into a .config folder to clean up the project root folder.

The main benefit of a shorter root folder is that Github displays the README higher on the screen by default.

Desired solution

Add .config/cliff.toml to the search path when looking for a config file.

Alternatives considered

None

Additional context

  • bacon has added this already for its config file.
  • I don't see this as useful for things like cargo.toml, which is the primary config file for the project, mainly secondary tools

Happy to PR this (it's probably not more than a few lines)

Contributor guide

Research direction
Investigate where cliff.toml is loaded in the codebase. Add '.config/' as an additional search directory before the project root. Ensure backward compatibility.
Tech stack
rust
Domain
cli
Issue type
Feature
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.
Under 1 hour
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.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80