Copilot instructions

1 
2Coding instructions for all programming languages:
3 
4- Never use emojis anywhere unless explicitly requested.
5- If no language is specified, assume the latest version of python.
6- If tokens or other secrets are needed, pull them from an environment variable
7- Prefer early returns over nested if statements.
8- Prefer `continue` within a loop vs nested if statements.
9- Prefer smaller functions over larger functions. Break up logic into smaller chunks with well-named functions.
10- Prefer constants with separators: `10_000` is preferred to `10000` (or `10_00` over `1000` in the case of a integer representing cents).
11- Only add comments if the code is not self-explanatory. Do not add obvious comments.
12- Do not remove existing comments.
13- Do not capitalize or add periods at the end of single-line comments.
14- When I ask you to write code, prioritize simplicity and legibility over covering all edge cases, handling all errors, etc.
15- When a particular need can be met with a mature, reasonably adopted and maintained package, I would prefer to use that package rather than engineering my own solution.
16- Never add error handling to catch an error without being asked to do so. Fail hard and early with assertions and allow exceptions to propagate.
17- When naming variables or functions, use names that describe the effect. For example, instead of `function handleClaimFreeTicket` (a function which opens a dialog box) use `function openClaimFreeTicketDialog`.
18- Do not install missing system packages! Instead, ask me to install them for you.
19- If terminal commands are failing because of missing variables or commands which are unrelated to your current task, stop your work and let me know.
20- Don't worry about fixing lint errors or running lint scripts unless I specifically ask you to.
21- When implementing workarounds for tooling limitations (like using `Any` for unresolvable types) or handling non-obvious edge cases, always add a brief inline comment explaining the technical reasoning.
22- Reserve exact-width `#`-box section separators for long files requiring organization, though they should not be necessary in the large majority of cases (separate files is generally better).
23 
24Use line breaks to organize code into logical groups. Instead of:
25 
26```python
27if not client_secret_id:
28    raise HTTPException(status.HTTP_400_BAD_REQUEST)
29session_id = client_secret_id.split("_secret")[0]
30```
31 
32Prefer:
33 
34```python
35if not client_secret_id:
36    raise HTTPException(status.HTTP_400_BAD_REQUEST)
37 
38session_id = client_secret_id.split("_secret")[0]
39```
40 
41**DO NOT FORGET**: keep your responses short, dense, and without fluff. I am a senior, well-educated software engineer, and hate long explanations.
42 
43### Add Comments for Expert Engineer with Limited Domain Knowledge
44 
45The engineer reading your code is a world-class software engineer, but is not familiar with the internals of every system. Include concise one-line comments explaining key hooks, API usage, blocks of logic, etc., to help the reader quickly understand the code you've written.
46 
47In other words, embed the business requirements as comments in the code when the code does not self-document.
48 
49### Important Workflow Rules
50 
51Pay careful attention to these instructions when running tests, generating database migrations, or otherwise figuring out how to operate this project:
52 
53- Run `just` to understand the more important workflow commands.
54  - Run `just --list` to see all available pre-written workflow development commands.
55- **IMPORTANT:** Never manually set environment variables that are required. You can set optional variables for debugging, but any missing required environment variables is an error that should be reported and you should stop your work immediately.
56- **NEVER** git commit changes. Always let me run any git commands which are not read-only.
57- Do not worry about cleaning up the environment. This is done automatically.
58- Run python code with `uv run python`
59- Use `pytest` to run tests. If tests fail because of a configuration, environment, or system error: let me know and stop working.
60  - Initially run `pytest --ignore=tests/integration` then only run `pytest tests/integration`
61  - When debugging integration tests look at `$PLAYWRIGHT_RESULT_DIRECTORY`. There's a directory for each test failure. In that directory you fill find a `failure.html` containing the rendered DOM of the page on failure and a screenshot of the contents. Use these to debug why it failed.
62- Do not attempt to create or run database migrations. Pause your work and let me know you need a migration run.
63  - If you receive errors about missing migrations, missing tables, database connectivity, etc, stop your work and let me know.
64