From ed496f34623ddf34bf6f3619d6ad3207e35c47aa Mon Sep 17 00:00:00 2001 From: SteveLauC Date: Tue, 23 Jan 2024 11:50:02 +0800 Subject: [PATCH] chore: fix file name typo[skip ci] (#657) chore: fix file name typo --- BREAKINGCHNAGES_dev.md => BREAKINGCHANGES_dev.md | 0 CONTRIBUTING.md | 4 +++- Cargo.toml | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) rename BREAKINGCHNAGES_dev.md => BREAKINGCHANGES_dev.md (100%) diff --git a/BREAKINGCHNAGES_dev.md b/BREAKINGCHANGES_dev.md similarity index 100% rename from BREAKINGCHNAGES_dev.md rename to BREAKINGCHANGES_dev.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ce03a91..4a5e2e87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,7 +103,7 @@ and have some basic documentations guiding user how to use these options. ## Breaking changes -If your PR introduces a breaking change, document it in `BREAKINGCHANGE_dev.md`, +If your PR introduces a breaking change, document it in [`BREAKINGCHANGES_dev.md`][bc_dev], it should be written in Markdown and wrapped in 80, for example: ```md @@ -114,6 +114,8 @@ it should be written in Markdown and wrapped in 80, for example: 3. ... ``` +[bc_dev]: https://github.com/topgrade-rs/topgrade/blob/main/BREAKINGCHANGES_dev.md + ## Before you submit your PR Make sure your patch passes the following tests on your host: diff --git a/Cargo.toml b/Cargo.toml index 1faf3d38..7d71f912 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,7 +7,7 @@ license = "GPL-3.0" repository = "https://github.com/topgrade-rs/topgrade" version = "14.0.0" authors = ["Roey Darwish Dror ", "Thomas Schönauer "] -exclude = ["doc/screenshot.gif", "BREAKINGCHNAGES_dev.md"] +exclude = ["doc/screenshot.gif", "BREAKINGCHANGES_dev.md"] edition = "2021" readme = "README.md"