Skip to content

Commit 6d9d833

Browse files
authored
docs: changes checklist (#466)
* docs: changes checklist * docs: handled Daniel's comments
1 parent 2fd9532 commit 6d9d833

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,16 @@ Before a PR is created and a PR review is requested, the PR author should go ove
7272
- [ ] The PR does not contain any breaking changes to the configuration and deployment files.
7373
(A change is _only_ considered breaking if a deployment configuration must be changed as part of an update. Adding new fields, with default values is _not_ considered breaking). Or if it does then these steps must be taken:
7474
- [ ] The PR is labeled with `devops`.
75+
- [ ] The PR is marked using `!` in accordance with conventional commits. E.g. `chore!: changed decryption format according to Q3 release`.
7576
- [ ] I have pinged the infra team on Slack (in the MPC channel).
7677
- [ ] I have put a devops person on the PR as reviewer.
78+
- [ ] I have added an issue for [infra](https://github.com/zama-ai/infra-internal) to take care of the changes needed.
7779
- [ ] The PR does not contain breaking changes to the gRPC interface or data serialized in the service gRPC interface. In particular there are no changes to the `extraData` fields. Or if it does the following steps have been taken:
7880
- [ ] The PR is marked using `!` in accordance with conventional commits. E.g. `chore!: changed decryption format according to Q3 release`.
7981
- [ ] The Gateway and Connector teams have been notified about this change.
82+
- [ ] A message has been posted in the Slack channel for the relevant guilds.
83+
- [ ] An issue has been made for the relevant teams to handle these changes.
84+
- [ ] The PR does not contain changes to the interal protobufs/communication protocols that breaks compatibility with the previous version. That is, if we release from `main` after your PR, the KMS can still communicate with other KMS' that run the previous release. This ensures a much simpler upgrade process, in order to avoid the green/blue upgrade approach.
8085
- [ ] I have not changed existing `versionized` structs, nor added new `versionized` structs. Or if I have, these steps must be taken:
8186
- [ ] The backwards compatibility tests have been updated and/or new tests covering the changes have been added.
8287
- [ ] The PR does not contain changes to the critical business logic or cryptographic code. Or if it does then these steps must be taken:

0 commit comments

Comments
 (0)