|
1 | 1 | # Gemini Code Review Instructions |
2 | 2 |
|
3 | 3 | - Do not comment on content for XML files or .matter content for clusters |
4 | | -- Assume the matter specification is unknown and out of scope. Do not make uninformed assumptions about the Matter specification, or its contents. |
5 | | -- Do not comment unless a change is probably desirable |
| 4 | +- The SDK is implementing an in-progress matter specification that may not be available yet. |
| 5 | + Assume the matter specification is unknown and out of scope. Do not make uninformed assumptions |
| 6 | + about the Matter specification, or its contents. |
| 7 | +- Do not comment unless a change is probably desirable |
6 | 8 | - Do not repeat yourself. Be concise without losing meaning |
7 | 9 | - Do not over-explain what you see in the code. Only describe code if there are specific questions or concerns (or if a question is asked) |
8 | 10 | - Ensure that extensions or fixes to existing code should match the prevailing style of the original code |
9 | 11 | - Look for common typos and suggest fixes |
10 | | -- The current year is 2025. |
11 | 12 | - Wrong years and years in the future are OK. Humans will catch these issues. |
12 | | -- Comments regarding issues about whitespace or code alignment are not needed. A code formatter will take care of these problems. |
| 13 | +- The SDK uses automated code formatting. Do not comment on whitespace, line length or other formatting |
| 14 | + or whitespace issues. A code formatter will handle this. |
| 15 | + |
| 16 | +## Development guides |
| 17 | + |
| 18 | +The SDK source code contains guides for development best practices in `docs/guides`, `docs/testing` and other `docs` locations. |
| 19 | +Use these as a reference for finding common patterns and potential issues in new code. In particular: |
| 20 | + - [docs/guides/writing_clusters](https://github.com/project-chip/connectedhomeip/blob/master/docs/guides/writing_clusters.md) describes how cluster handling |
| 21 | + is to be implemented |
| 22 | + - [docs/guides/migrating_ember_cluster_to_code_driven.md](https://github.com/project-chip/connectedhomeip/blob/master/docs/guides/migrating_ember_cluster_to_code_driven.md) |
| 23 | + describes how ember clusters can be migrated to code driven |
| 24 | + - [docs/testing/unit_testing.md](https://github.com/project-chip/connectedhomeip/blob/master/docs/testing/unit_testing.md) |
| 25 | + describes how to implement unit testing |
| 26 | + - [docs/testing/integration_tests.md](https://github.com/project-chip/connectedhomeip/blob/master/docs/testing/integration_tests.md) |
| 27 | + describes how to implement integration tests. |
| 28 | + |
| 29 | + |
0 commit comments