@@ -25,27 +25,31 @@ If you add or update dependencies:
2525
2626## 3. Coding Conventions
2727
28- * Follow Black formatting (120 character line length).
28+ * Follow Black formatting (120- character line length).
2929* Use isort for import sorting (Black-compatible profile).
30- * Follow Flake8 linting rules (E203 ignored for Black compatibility).
30+ * Follow Flake8 linting rules (ignore E203 and W503 for Black compatibility).
3131* Use type hints where appropriate.
3232* Keep MyPy checks passing.
3333
3434## 4. Code Quality Checks
3535
3636Before completing any task, run these quality checks:
3737
38- | Command | Purpose |
39- | ------------------------ | ------------------------------------------ |
40- | ` poetry run black . ` | Format code to project standards |
41- | ` poetry run isort . ` | Sort imports |
42- | ` poetry run flake8 ` | Run linting checks |
43- | ` poetry run mypy . ` | Run type checking |
38+ | Command | Purpose |
39+ | ------------------------ | ----------------------------------|
40+ | ` poetry run black . ` | Format code to project standards |
41+ | ` poetry run isort . ` | Sort imports |
42+ | ` poetry run flake8 ` | Run linting checks |
43+ | ` poetry run mypy . ` | Run type checks |
4444
4545Or use pre-commit hooks:
4646``` bash
4747poetry run pre-commit run --all-files
4848```
49+ If running pre-commit hooks for the first time, run this first:
50+ ``` bash
51+ poetry run pre-commit install
52+ ```
4953
5054## 5. Testing Guidelines
5155
@@ -66,7 +70,7 @@ Test changes progressively:
6670
6771When creating or modifying profiles:
6872
69- * Place custom profiles in appropriate subdirectories.
73+ * Place custom profiles in the canonical directory: ` chainbench/profile/<network>/… `
7074* Follow existing profile structure and conventions.
7175* Include docstrings explaining profile purpose.
7276* Test with small data sizes first (` --size XS ` ).
@@ -90,10 +94,12 @@ When creating or modifying profiles:
9094
9195## 9. Useful Commands Recap
9296
93- | Command | Purpose |
94- | ------------------------------------------------- | ------------------------------------- |
95- | ` poetry install ` | Install all dependencies |
97+ | Command | Purpose |
98+ | ------------------------------------------------ | ------------------------------------- |
99+ | ` poetry install ` | Install all dependencies |
96100| ` poetry run chainbench --help ` | Show all available commands |
101+ | ` poetry run chainbench start --help ` | Show options for running a benchmark |
102+ | ` poetry run chainbench --version ` | Show CLI version |
97103| ` poetry run chainbench list methods ` | List supported RPC methods |
98104| ` poetry run chainbench list profiles ` | List available profiles |
99105| ` poetry run chainbench list shapes ` | List load pattern shapes |
0 commit comments