diff --git a/.github/nitpicks.yml b/.github/nitpicks.yml index 5181b1eee4..38c77b3a5b 100644 --- a/.github/nitpicks.yml +++ b/.github/nitpicks.yml @@ -1,4 +1,13 @@ - markdown: | - Reminder: Please update the DB Readme. + Reminder: Please update the DB Readme and comment whether migrations are reversible (include rollback scripts if applicable). pathFilter: - "database/sql/**" + +- markdown: | + Reminder: Please consider backward compatibility when modifying the API specification. + If breaking changes are unavoidable, ensure: + - You explicitly pointed out breaking changes. + - You communicate the changes to affected teams. + - You provide proper versioning and migration mechanisms. + pathFilter: + - "**/openapi.yml"