Skip to content

Commit 78b3f47

Browse files
authored
Update README.md
1 parent acdf41e commit 78b3f47

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,15 @@ Protobuf definitions for Viam's public-facing API.
1313

1414
### Submitting PRs for Protobuf Changes
1515

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.
1822

1923
## License
2024

21-
Copyright 2022 Viam Inc.
25+
Copyright 2023 Viam Inc.
2226

2327
Apache 2.0 - See [LICENSE](https://github.com/viamrobotics/api/blob/main/LICENSE) file

0 commit comments

Comments
 (0)