Skip to content

Commit e9a514e

Browse files
Garfield-yinclaude
andcommitted
docs: drop CONTRIBUTING.md and CODE_OF_CONDUCT.md
Both were boilerplate for a project this size. What was actually load-bearing in CONTRIBUTING — how to build and test, the warning to probe the backend before adding a route, and what counts as a breaking change — moves into the README's development section, where someone will actually see it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 2543739 commit e9a514e

3 files changed

Lines changed: 15 additions & 129 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -166,19 +166,28 @@ Rendering is performed by [`@deckops/sdk`](https://www.npmjs.com/package/@deckop
166166
167167
Most rendering runs in the DeckFlow cloud; a few formats are handled on your machine. Which is which is an implementation detail — `deckrender formats` reports what works, and `--json` reports how it was produced if you need to know.
168168
169-
## Contributing
169+
## Development
170170
171-
Issues and pull requests are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).
171+
Issues and pull requests are welcome. Node.js 18 or newer.
172172
173173
```bash
174174
pnpm install
175-
pnpm check # typecheck + lint + unit + integration
176-
pnpm build && pnpm test:e2e
175+
pnpm check # typecheck + lint + unit + integration
176+
pnpm build && pnpm test:e2e # e2e drives the built binary
177177
178-
# Optional: exercise the real guest cloud path
179-
DECKRENDER_E2E=1 pnpm test:cloud
178+
DECKRENDER_E2E=1 pnpm test:cloud # guest render against the live backend
179+
pnpm test:conformance # every format pair; needs credentials
180180
```
181181
182+
The route table in `src/core/routes.ts` decides what converts to what. Probe the
183+
backend before adding to it — several plausible-looking conversions do not
184+
actually work, so a route inferred from type definitions alone can be wrong.
185+
`pnpm test:conformance` confirms the matrix end to end.
186+
187+
The `--json` envelope, error codes, exit codes and the shared credential file
188+
format are what other people's scripts depend on. Changing any of them is a
189+
breaking change; note it in `CHANGELOG.md`.
190+
182191
## License
183192
184193
MIT © DeckFlow

0 commit comments

Comments
 (0)