skill(apm-integrations): split tests.md into mandatory rules + situational style guide - #12410
Draft
jordan-wong wants to merge 1 commit into
Draft
skill(apm-integrations): split tests.md into mandatory rules + situational style guide#12410jordan-wong wants to merge 1 commit into
jordan-wong wants to merge 1 commit into
Conversation
…ional style guide tests.md mixed always-applicable rules (DSL choice, error-test coverage, no-sleep hygiene) with situational rules that only apply to specific circumstances (version-mismatch comments, mutual-exclusion deps, latestDepTest source-set routing, banner-comment style) and their code examples — 179 lines every reader loaded via SKILL.md's Step 9.1 pointer, regardless of whether their module hit any of those cases. Split into: - tests.md (28 lines) — the mandatory checklist: DSL rule, error-test requirement, ForkedTest naming, integration-name registration, no-Thread.sleep/no-default-jvmArgs hygiene. This is what SKILL.md Step 9.1 points to. - tests-style.md (148 lines) — situational rules + all code examples, linked from tests.md for the specific cases that need them. Also folds in the DSL-rule clarification from #12359 ("Full Java instrumentation test support is not yet available" read as an absolute ban that the repo's own Java-DSL test suites contradict — restated as unconditional-unless-already-Java-DSL). Updated SKILL.md's two references/tests.md pointers (Step 9.1, Step 9.3's latestDepTest pointer) to match the new file split. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
🎯 Code Coverage (details) 🔗 Commit SHA: 3a927df | Docs | View more details | Give us feedback! |
Contributor
🟢 Java Benchmark SLOs — All performance SLOs passed
PR vs. master results
Commit: Load and DaCapo benchmarks can be triggered manually in the GitLab pipeline. Results will appear in the Benchmarking Platform UI after completion. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 Generated with APM Instrumentation Toolkit
Reference / skill-fix PR. Two
apm-integrationsskill files; docs-only, no instrumentation code changes.Splits
tests.mdso the rules every module needs aren't buried in the ones only some modules hit — restructuring alternative to #12359's inline trim, opened for comparison.Changes
references/tests.mdmixed always-applicable rules (DSL choice, error-test coverage, no-sleep hygiene) with situational rules and code examples that only apply to specific circumstances (version-mismatch comments, mutual-exclusion deps,latestDepTestsource-set routing, banner-comment style) — 179 lines every reader loaded viaSKILL.mdStep 9.1's pointer, regardless of whether their module hit any of those cases.tests.md(28 lines) — the mandatory checklist only: DSL rule, error-test requirement,ForkedTestnaming, integration-name registration, no-Thread.sleep()/no-default-jvmArgshygiene.tests-style.md(148 lines, new) — situational rules + all code examples, linked fromtests.mdfor the specific cases that need them.Also folds in the DSL-rule clarification from #12359 (the old "Full Java instrumentation test support is not yet available" read as an absolute ban the repo's own Java-DSL test suites contradict).
Scope
references/tests.md,references/tests-style.md(new),SKILL.md— docs-only.Alternative to #12359 — pick one; they overlap on the DSL-rule content.