Skip to content

Fix #133: Correct CONTRIBUTING.md inaccuracies#150

Open
mcurrier2 wants to merge 1 commit into
mainfrom
fix/133-contributing-docs
Open

Fix #133: Correct CONTRIBUTING.md inaccuracies#150
mcurrier2 wants to merge 1 commit into
mainfrom
fix/133-contributing-docs

Conversation

@mcurrier2

Copy link
Copy Markdown
Collaborator

Summary

  • Fixes 6 significant inaccuracies in CONTRIBUTING.md where documented processes, code examples, and directory structures did not match the actual project
  • Replaces fictional code patterns (TransportManager, criterion benchmarks) with real ones
  • Updates stale paths and tooling references

Key Fixes

Section Before After
New Transport Only async IpcTransport Both async + BlockingIpcTransport
Test layout tests/unit/, tests/integration/, etc. Actual flat tests/integration_*.rs files
Doc example Fictional TransportManager struct Real TransportFactory::create()
Performance cargo bench / criterion Binary benchmarking workflow
Git hooks cp scripts/pre-commit .git/hooks/ git config core.hooksPath .githooks
CI Single-job actions-rs/toolchain@v1 Multi-job pipeline description

Test plan

  • No code changes — documentation only

Closes #133

Made with Cursor

- Fix "Implementing a New Transport" section: document both async
  (IpcTransport) and blocking (BlockingIpcTransport) requirements,
  file naming convention, and factory registration
- Fix test directory layout: replace fictional tests/unit/,
  tests/integration/, tests/benchmarks/, tests/fixtures/ with actual
  flat integration test files under tests/
- Remove fictional TransportManager documentation example, replace
  with actual TransportFactory::create() pattern
- Remove fictional criterion/cargo bench section (no bench targets
  exist), replace with actual performance testing workflow
- Fix pre-commit hook path: "cp scripts/pre-commit .git/hooks/" ->
  "git config core.hooksPath .githooks" or install-git-hooks.sh
- Fix CI workflow: replace simplified actions-rs/toolchain@v1 example
  with accurate description of actual multi-job pipeline
- Fix Performance Considerations: "cargo bench" -> binary benchmarking

AI-assisted-by: Claude Opus 4 (claude-sonnet-4-20250514)
Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@mcurrier2, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 11 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 3eb5acb1-1973-414b-ba7f-9a455f74b1f6

📥 Commits

Reviewing files that changed from the base of the PR and between b2e22b2 and 8115db8.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

📈 Changed lines coverage: N/A (0/0)

✅ All new and modified lines are covered by tests!

📊 Code Coverage Summary

File Line Coverage Uncovered Lines
src/benchmark.rs 83.69%
(513/613)
75, 78, 89, 93, 102, 105, 107, 124, 424, 429-434, 441-446, 513-516, 621, 631, 711, 723-725, 745, 814-816, 821, 842, 847, 865, 971, 975-978, 980, 989-992, 994, 1070, 1101, 1104, 1106-1107, 1116-1117, 1140, 1262, 1275, 1292, 1328, 1418, 1427, 1429-1430, 1433-1434, 1440-1441, 1446-1447, 1449, 1454-1455, 1459-1461, 1466-1467, 1470-1471, 1503, 1561-1565, 1567-1573, 1575, 1578, 1631, 1738, 1753
src/benchmark_blocking.rs 73.77%
(329/446)
97, 111, 127, 263, 369, 380-382, 402, 434, 495, 594, 607, 621, 651-654, 739-742, 761, 765, 780, 822, 824-826, 830, 833-835, 837, 840, 842-846, 848-849, 857-861, 863-867, 870-871, 874-875, 881-882, 917, 966, 1048, 1059, 1089, 1092, 1135, 1160-1165, 1167, 1225-1228, 1233, 1246, 1249-1252, 1256, 1258-1261, 1263, 1265-1266, 1268-1269, 1272, 1274-1279, 1281, 1285-1286, 1288, 1290, 1314, 1326-1331, 1333, 1353-1356, 1364
src/cli.rs 92.39%
(85/92)
691, 790, 830, 832, 853-855
src/execution_mode.rs 100.00%
(14/14)
``
src/ipc/mod.rs 63.64%
(49/77)
134, 458, 460-463, 773-774, 789-790, 808-809, 840, 843, 846, 851, 878-879, 893, 895, 915, 917, 1040-1042, 1231-1233
src/ipc/posix_message_queue.rs 46.09%
(59/128)
139-140, 213-215, 217, 224, 229, 332-335, 337, 345, 437, 441-442, 446, 449-452, 454-458, 539, 679, 782, 789-790, 807-808, 819-820, 831-832, 849-850, 906, 910-911, 914-919, 921-923, 927, 929-931, 933, 935-937, 941-943, 945-947, 994-995, 1017
src/ipc/posix_message_queue_blocking.rs 72.16%
(127/176)
172, 182, 221, 251-255, 274, 325, 368, 387-390, 416-418, 422-423, 425-426, 436, 455, 457-458, 460-461, 474-475, 477-478, 484, 486-491, 493-495, 497-498, 503, 505-506, 508-509
src/ipc/shared_memory.rs 69.36%
(163/235)
69, 152, 156, 257-258, 268-269, 273, 401-402, 428-430, 432, 450-452, 454-455, 457-461, 478, 485, 491, 494-495, 499, 503, 507-508, 513-514, 677-678, 681-682, 685, 687, 692-693, 720-721, 724-725, 732-734, 736, 738-743, 745-746, 749-750, 752-756, 763, 793, 795-796, 798, 802
src/ipc/shared_memory_blocking.rs 77.35%
(222/287)
199-201, 203-204, 207-209, 212-213, 215, 220, 222, 226-228, 233, 241-243, 246-248, 251-252, 254, 257, 260-261, 264-265, 269-270, 272, 276-277, 279, 315-316, 403-404, 428-432, 544, 552, 602, 619, 706, 772, 805-806, 808-809, 816, 833, 835-836, 838, 871, 880, 890, 912
src/ipc/shared_memory_direct.rs 77.93%
(166/213)
188, 195-198, 207, 215-216, 221-225, 234-235, 434-437, 506-513, 517, 545, 570-573, 577-578, 624-625, 637, 667, 674-675, 731-732, 738, 760, 765-766
src/ipc/tcp_socket.rs 59.43%
(63/106)
31-32, 61, 96, 113-114, 118, 124-125, 129, 136-137, 141, 147-148, 152, 171-172, 175-177, 184-185, 188, 362-363, 366-367, 370-371, 376-377, 422, 429, 447-449, 478, 480-482, 484, 487
src/ipc/tcp_socket_blocking.rs 94.23%
(98/104)
145, 170, 322-325
src/ipc/unix_domain_socket.rs 59.43%
(63/106)
29-30, 58, 93, 103, 122-123, 127, 133-134, 138, 145-146, 150, 156-157, 161, 180-181, 184-186, 193-194, 197, 346-347, 350-351, 354-355, 360-361, 412-414, 443, 445-447, 449, 452, 468
src/ipc/unix_domain_socket_blocking.rs 92.06%
(116/126)
287-288, 294-296, 298, 363-366
src/logging.rs 47.69%
(31/65)
91, 93, 95, 97-100, 103, 106-108, 111, 125, 144, 150, 157-160, 162, 165-168, 170-171, 173-174, 176, 179-181, 183, 186
src/main.rs 51.03%
(148/290)
83-85, 87, 134-138, 146, 152, 155, 160-163, 168-169, 175, 181, 183-185, 187, 193-194, 200, 205, 208-209, 213, 215-216, 220-221, 223, 229, 233-234, 236-241, 243-244, 247, 256, 259-260, 263, 312-314, 317, 319, 322, 326, 331-334, 340-341, 347-348, 354, 356-357, 361, 363, 368-370, 374, 377-378, 380-381, 386, 388-390, 394-395, 397, 404, 409-410, 412-417, 419-420, 424, 433, 436-437, 440, 442, 461, 468, 472-474, 476, 504-505, 513, 546, 581, 606, 610, 613-616, 672-673, 680-681, 684, 711-712, 715, 752, 773-774, 778-781, 803, 830, 839, 844, 849-850
src/metrics.rs 84.04%
(158/188)
455-460, 493-494, 552, 558, 579-582, 732-734, 736, 768, 833, 838, 881, 904, 952, 980, 984, 1005, 1007-1008, 1013
src/results.rs 56.60%
(253/447)
726, 735-737, 739-740, 743-744, 747, 769, 772-773, 776, 778, 781, 785-790, 800-801, 804-809, 826, 838-839, 841, 843, 846-847, 849, 853, 880, 904-906, 909-910, 914-916, 919, 945, 950, 955, 961, 980, 982-983, 985, 987-991, 993, 995-996, 1030, 1071-1072, 1075, 1081-1082, 1086, 1090-1092, 1094-1095, 1119-1123, 1126-1129, 1132-1141, 1151-1152, 1171-1172, 1174-1178, 1180, 1197-1198, 1200-1205, 1207, 1225, 1227-1232, 1250, 1253, 1269-1270, 1285-1287, 1289-1291, 1293-1294, 1296-1297, 1299-1300, 1302, 1304-1305, 1307-1310, 1312-1314, 1316-1318, 1321, 1325-1326, 1334-1339, 1341-1342, 1346-1347, 1351-1353, 1355, 1359-1360, 1369-1372, 1376-1378, 1382, 1384-1385, 1393-1394, 1399, 1406-1410, 1412, 1610-1611, 1831-1832, 1834-1835
src/results_blocking.rs 95.51%
(298/312)
489-490, 492-493, 544, 769, 774, 779, 815, 818-819, 827-828, 886
src/standalone_client.rs 84.85%
(633/746)
38, 71-72, 74, 83-86, 96-98, 100, 104, 120, 141, 243, 263, 307, 348, 352, 383, 401, 500, 518, 529, 536, 601, 604-605, 613-633, 635-636, 638, 662, 669, 685, 723, 726, 748-750, 755-756, 844, 864, 880, 908, 911-912, 949, 953, 984, 988, 1002, 1009, 1092, 1110, 1121, 1128, 1131, 1188, 1191-1192, 1200-1220, 1222-1223, 1225, 1249, 1256, 1259, 1271, 1308, 1311
src/standalone_server.rs 77.91%
(395/507)
136, 159, 191-192, 194, 204-206, 208, 247, 272-273, 296-298, 322-323, 408-409, 412-413, 433-434, 444-445, 448, 450, 452, 462-465, 472, 480-483, 508, 540-541, 556-557, 567-568, 571, 573, 575, 585-588, 595, 606-609, 655, 734-735, 753-755, 759-761, 811-813, 817-818, 821-822, 838-839, 846-849, 858, 863-864, 867, 869, 871, 881, 888-891, 913, 943-945, 949-950, 962-963, 970-973, 982, 987-988, 991, 993, 995, 1005, 1014-1017
src/utils.rs 75.00%
(42/56)
143, 147-148, 153, 159, 198-202, 239-242
Total 75.46%
(4025/5334)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CONTRIBUTING.md: wrong test layout, fictional TransportManager, stale hook/CI paths

1 participant