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: summer-student-scope.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,6 +59,26 @@ Do not attempt these unless the required work is already complete and reviewed:
59
59
- replacing the capture test framework;
60
60
- adding external runtime dependencies beyond approved development tooling.
61
61
62
+
## Repository Conventions To Know
63
+
64
+
- The CLI is tested against CBRAIN, the server application at https://github.com/aces/cbrain.
65
+
- The capture tests expect a local CBRAIN test server on `localhost:3000` with the expected seeded test database.
66
+
- You are not expected to have production CBRAIN credentials. Use local/test credentials only.
67
+
- If setting up the CBRAIN test server blocks you, say so early. You can still write unit tests and note that capture tests were not run locally.
68
+
-`capture_tests/switch_session` writes test credentials directly to `$HOME/.config/cbrain/credentials.json`; do not run it casually against a real CLI session.
69
+
- The repo-root `cbrain` script is the local CLI entrypoint used by the capture tests.
70
+
- Runtime code is intended to use only the Python standard library unless a dependency is explicitly approved.
71
+
- Output formatting is part of the tested behavior. If command output changes, update capture expectations only when the new output is intentional.
72
+
- CBRAIN-specific terms such as `bourreau`, `data provider`, and `tool config` come from the server/domain model; refer to the server repository when behavior is unclear.
73
+
74
+
## Remote Collaboration
75
+
76
+
- Work asynchronously and make progress visible with small PRs or draft PRs.
77
+
- Mention your timezone and typical working hours in your first project update.
78
+
- Ask questions early when setup, CBRAIN terminology, or expected behavior is unclear.
79
+
- If you cannot run a test locally, say exactly which test was skipped and why.
80
+
- PR descriptions should include the commands you ran and any remaining uncertainty.
81
+
62
82
## Suggested Timeline
63
83
64
84
Note: in this repository, "capture tests" means the existing shell-based CLI output regression tests in `capture_tests/`. They run CLI commands and compare captured terminal output against `expected_captures.txt`.
0 commit comments