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
Copy file name to clipboardExpand all lines: AGENTS.md
+11-18Lines changed: 11 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,26 +61,19 @@ make install
61
61
62
62
### Running Tests
63
63
64
-
To execute the unit tests across different Python versions:
65
-
```bash
66
-
make test
67
-
```
68
-
This command runs `tox`, which manages the test environments.
69
-
70
-
### Code Style & Formatting
71
-
72
-
We use `flake8`for linting and `black`for formatting.
64
+
You can run the unit tests using two main methods:
73
65
74
-
- **Check for style violations and type errors**:
75
-
```bash
76
-
make lint
77
-
```
78
-
- **Apply formatting**:
79
-
```bash
80
-
make format
81
-
```
66
+
1. **Directly via `make`**: For a quick run of the test suite in your current environment.
67
+
```bash
68
+
make tests
69
+
```
70
+
This command executes the tests using Python's built-in `unittest` module.
82
71
83
-
The build will fail if there are any linting violations. Run `make format` before committing.
72
+
2. **Via `tox`**: For comprehensive testing across multiple Python versions, as is done in the CI pipeline.
73
+
```bash
74
+
tox
75
+
```
76
+
This command uses the `tox.ini` configuration to create isolated environments and run tests in each, ensuring compatibility. This is the method used in our GitHub Actions workflow.
0 commit comments