feat: inform users of breaking changes on first run (#619)

This commit is contained in:
SteveLauC
2023-12-03 09:52:35 +08:00
committed by GitHub
parent 18b37ce3e3
commit 788e0412f6
6 changed files with 203 additions and 5 deletions

View File

@@ -101,6 +101,19 @@ Be sure to apply your changes to
[`config.example.toml`](https://github.com/topgrade-rs/topgrade/blob/master/config.example.toml),
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`,
it should be written in Markdown and wrapped in 80, for example:
```md
1. The configuration location has been updated to x.
2. The step x has been removed.
3. ...
```
## Before you submit your PR
Make sure your patch passes the following tests on your host: