Skip to content

Commit

Permalink
OpenAPI change reminder (#3138)
Browse files Browse the repository at this point in the history
- Nudges author to think about backwards compatibility when openapi.yml
changes.
- Reminds to make DB migration revertable.
  • Loading branch information
squadgazzz authored Nov 28, 2024
1 parent 5ff9cec commit 7359612
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion .github/nitpicks.yml
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit 7359612

Please sign in to comment.