You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Firstly, find the command signature, their format is `... g.custom_command('{command_signature}', ...)...` or `... g.command('{command_signature}', ...)...`, {command_signature} is the command signature
196
+
Next, you need to determine whether the command signature is a dangerous operation, such as `delete`, `remove`, `stop` operation which will break or remove resources. If so, You need to suggest adding the flag `confirmation=True`, such as `g.custom_command('{command_signature}', ..., )...`
197
+
198
+
### 3. Common code best practices
199
+
- Use 4 spaces for indentation, never mix tabs and spaces
200
+
- Naming:
201
+
(1) Variables/functions: snake_case
202
+
(2) Classes: CamelCase
203
+
(3) Constants: UPPER_CASE_WITH_UNDERSCORES
204
+
- Surround operators with spaces (x = y + 1), except in function parameters
205
+
- Avoid extraneous whitespace in brackets, before commas/colons
206
+
- Handle exceptions explicitly using try-except blocks
207
+
- Break long expressions using parentheses alignment or hanging indents
208
+
- Use blank lines: two between top-level definitions, one between methods
209
+
179
210
## Important Notes for Agents
180
211
181
212
1.**ALWAYS use azdev**: Never use the deprecated `dev_setup.py` script
@@ -186,4 +217,4 @@ The repository enforces several checks before code integration:
186
217
6.**Incremental testing**: Use module-specific tests during development, not full suite
187
218
7.**Network resilience**: Be prepared for pip timeout issues and retry with longer timeouts
188
219
189
-
This repository has complex build requirements but following these instructions will minimize exploration time and avoid common pitfalls. The development workflow is well-established through azdev tooling.
220
+
This repository has complex build requirements but following these instructions will minimize exploration time and avoid common pitfalls. The development workflow is well-established through azdev tooling.
0 commit comments