File tree Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Original file line number Diff line number Diff line change @@ -13,11 +13,15 @@ Protobuf definitions for Viam's public-facing API.
13
13
14
14
### Submitting PRs for Protobuf Changes
15
15
16
- - Only submit PRs with changes to ` .proto ` files, CI will handle generating other files
17
- - Do not make breaking changes to APIs if it can be avoided
16
+ - Only submit PRs with changes to ` .proto ` files, CI will handle generating other files.
17
+ - Upon (first) approval of the PR, file generation will happen.
18
+ - Wait for it to complete (it will add a ` protos-compiled ` label and new files to the PR) before merging.
19
+ - Do not make further changes after this point.
20
+ - If stuck waiting for merge checks _ after_ ` protos-compiled ` is added, try adding an unrelated label (ex: ` enhancement ` ) to trigger it again.
21
+ - Do not make breaking changes to APIs if it can be avoided.
18
22
19
23
## License
20
24
21
- Copyright 2022 Viam Inc.
25
+ Copyright 2023 Viam Inc.
22
26
23
27
Apache 2.0 - See [ LICENSE] ( https://github.com/viamrobotics/api/blob/main/LICENSE ) file
You can’t perform that action at this time.
0 commit comments