-
Notifications
You must be signed in to change notification settings - Fork 868
AI agent instruction updates #13335
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
AI agent instruction updates #13335
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -123,12 +123,15 @@ regularly). | |
| using the Proxy Verifier format. This is simpler, more maintainable, and | ||
| parseable by tools. | ||
|
|
||
| **Python conventions for test and helper scripts:** | ||
| - Launch Python helpers with `{sys.executable}` rather than a hardcoded `python3`, | ||
| so the test runs under the same interpreter the harness uses. | ||
| - Prefer f-strings over `str.format()` when building command lines, config lines, | ||
| and `Testers` expressions. | ||
| - Add type annotations to helper functions. | ||
| If `ATSReplayTest` is not a good fit (say, the test needs a custom client), then | ||
| organize the test around a test class with member functions that configure any | ||
| servers, the ATS process, and the client. See | ||
| `tests/gold_tests/ats_probe/ats_probe.test.py` for an example of a test organized | ||
| around a test class. | ||
|
|
||
| In autests, launch Python helpers with `{sys.executable}` rather than a | ||
| hardcoded `python3`, so the test runs under the same interpreter the harness | ||
| uses. | ||
|
|
||
| **For complete details on writing autests, see:** | ||
| - `doc/developer-guide/testing/autests.en.rst` - Comprehensive guide to autest | ||
|
|
@@ -313,7 +316,11 @@ SMDebug(dbg_ctl, "Processing request for URL: %s", url); | |
| - CamelCase for classes: `HttpSM`, `NetVConnection` | ||
| - snake_case for variables and functions: `server_entry`, `handle_api_return()` | ||
| - UPPER_CASE for macros and constants: `HTTP_SM_SET_DEFAULT_HANDLER` | ||
| - Private member variables have the `m_` prefix. | ||
| - Private member variables use both `_` and `m_` prefixes in the source code; | ||
| be consistent with the surrounding code. For new files, prefer the `_` prefix | ||
| because that reflects the community consensus. | ||
| - Boolean variables and functions returning boolean values are named as | ||
| predicates: use `was_modified` rather than `modified`. | ||
|
Comment on lines
+319
to
+323
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Yeah, you and I lost that argument. The community prefers
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It seems identifiers with leading
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the reference. |
||
|
|
||
| **Doxygen Comments:** | ||
|
|
||
|
|
@@ -364,6 +371,9 @@ MIOBuffer *buffer = (MIOBuffer*)malloc(sizeof(MIOBuffer)); | |
| ### Python Code Style (for tests and tools) | ||
| - Python 3.11+ with proper type annotations | ||
| - 4-space indentation, never TABs | ||
| - Type annotations on all function signatures | ||
| - Prefer f-strings over `str.format()` when building command lines, config lines, | ||
| and `Testers` expressions. | ||
|
|
||
| ### Memory Management | ||
| - Custom allocators supported (jemalloc, mimalloc) | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.