Drop the rule that left starting dev servers to the user
This commit is contained in:
1 parent
86ea1a3374
commit
8316c8a1bf
2 files changed
+4
-8
No files matched your search
@@ -18,8 +18,6 @@ I wanted to share some of my preferences here so we can be more aligned as we wo
|
|||||||
- Tests are good! Endless smoke tests, "regression tests" for feature deletions, etc, much less good. Tests should be focused. Not slop.
|
- Tests are good! Endless smoke tests, "regression tests" for feature deletions, etc, much less good. Tests should be focused. Not slop.
|
||||||
- Comments are a great way to clarify functionality & how code is used. Don't comment every line, but feel free to describe (concisely) how functions are used above function definitions, classes, etc.
|
- Comments are a great way to clarify functionality & how code is used. Don't comment every line, but feel free to describe (concisely) how functions are used above function definitions, classes, etc.
|
||||||
- Keep all comments and documentation up to date! When making changes, it is important to keep everything in sync.
|
- Keep all comments and documentation up to date! When making changes, it is important to keep everything in sync.
|
||||||
- Avoid starting long running dev servers by default; assume the user may already have one running unless the task requires otherwise.
|
|
||||||
- If the user does not have a dev server running, or if you need to restart the dev server, ask the user to do so.
|
|
||||||
|
|
||||||
## TypeScript Preferences
|
## TypeScript Preferences
|
||||||
|
|
||||||
|
|||||||
@@ -40,16 +40,14 @@ an implementation with extra steps.
|
|||||||
routing and file conventions; invent no new top-level structure.
|
routing and file conventions; invent no new top-level structure.
|
||||||
2. **Trivial to run.** A UI prototype is one URL. A logic demo is one file that opens on a
|
2. **Trivial to run.** A UI prototype is one URL. A logic demo is one file that opens on a
|
||||||
double-click. No thinking required to start it.
|
double-click. No thinking required to start it.
|
||||||
3. **Do not start a dev server yourself.** Assume one may already be running. Where the prototype
|
3. **No persistence by default.** State lives in memory. Persistence is usually the thing being
|
||||||
needs a server that is not up, or needs a restart, ask rather than starting it.
|
|
||||||
4. **No persistence by default.** State lives in memory. Persistence is usually the thing being
|
|
||||||
*checked*, not something to depend on. Where the question genuinely involves the database, point
|
*checked*, not something to depend on. Where the question genuinely involves the database, point
|
||||||
at a scratch one named so nobody mistakes it.
|
at a scratch one named so nobody mistakes it.
|
||||||
5. **Skip the polish.** No tests, no error handling beyond what makes it run, no abstractions. A
|
4. **Skip the polish.** No tests, no error handling beyond what makes it run, no abstractions. A
|
||||||
prototype that needs tests has stopped being a prototype.
|
prototype that needs tests has stopped being a prototype.
|
||||||
6. **Surface the state.** After every action, or on every variant switch, render the full relevant
|
5. **Surface the state.** After every action, or on every variant switch, render the full relevant
|
||||||
state so the change is visible.
|
state so the change is visible.
|
||||||
7. **Answer one question.** No "what if we also wanted X later".
|
6. **Answer one question.** No "what if we also wanted X later".
|
||||||
|
|
||||||
## Capture it when the answer arrives
|
## Capture it when the answer arrives
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user