Skip to content

Commit ae8ab84

Browse files
Copilottikazyq
andcommitted
refactor(tests): remove ignored template test, add as doc comment
Address code review feedback - move template to doc comments instead of keeping as ignored test Co-authored-by: tikazyq <3393101+tikazyq@users.noreply.github.com>
1 parent 1379610 commit ae8ab84

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

rust/leanspec-cli/tests/regression.rs

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,28 +30,31 @@ use common::*;
3030
/// 1. Reproduce the exact conditions that triggered the bug
3131
/// 2. Verify the bug no longer occurs with the fix
3232
/// 3. Document the issue number and brief description
33-
34-
#[test]
35-
#[ignore = "Template test - replace with actual regression test"]
36-
fn test_regression_template() {
37-
// SETUP: Create the conditions that triggered the bug
38-
let ctx = TestContext::new();
39-
let cwd = ctx.path();
40-
init_project(cwd, true);
41-
42-
// Example setup: Create a spec, modify a file, etc.
43-
// create_spec(cwd, "test-spec");
44-
45-
// ACTION: Perform the action that used to trigger the bug
46-
// Example: Run a command, call a function, etc.
47-
48-
// ASSERT: Verify the bug no longer occurs
49-
// Example: Check file contents, verify output, etc.
50-
51-
// The test should:
52-
// - FAIL if the bug is present (before fix)
53-
// - PASS if the bug is fixed (after fix)
54-
}
33+
///
34+
/// ## Template for New Regression Tests
35+
///
36+
/// ```rust
37+
/// #[test]
38+
/// fn test_regression_issue_NUMBER_brief_description() {
39+
/// // SETUP: Create the conditions that triggered the bug
40+
/// let ctx = TestContext::new();
41+
/// let cwd = ctx.path();
42+
/// init_project(cwd, true);
43+
///
44+
/// // Example setup: Create a spec, modify a file, etc.
45+
/// // create_spec(cwd, "test-spec");
46+
///
47+
/// // ACTION: Perform the action that used to trigger the bug
48+
/// // Example: Run a command, call a function, etc.
49+
///
50+
/// // ASSERT: Verify the bug no longer occurs
51+
/// // Example: Check file contents, verify output, etc.
52+
///
53+
/// // The test should:
54+
/// // - FAIL if the bug is present (before fix)
55+
/// // - PASS if the bug is fixed (after fix)
56+
/// }
57+
/// ```
5558
5659
/// Example: Real regression test for reference
5760
///

0 commit comments

Comments
 (0)