Skip to content

Commit 80dc517

Browse files
jaredcosulichclaude
andcommitted
docs: add CONTRIBUTING guide recommending codeyam-editor
New contributor guide: recommends making changes through codeyam-editor so code, tests, and scenarios stay in sync, with the standard npm build/test/lint workflow documented as the by-hand path. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SYwMo8FrGx57SVf1BY96Qt
1 parent 29c865f commit 80dc517

1 file changed

Lines changed: 65 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing! TabCommand is a Manifest V3 Chrome
4+
extension built with React and Vite, and developed with
5+
[codeyam-editor](https://codeyam.com) — the app's code and its runnable data
6+
**scenarios** are authored side by side against a live preview, and its test
7+
suite is captured and maintained as part of the same workflow.
8+
9+
## The recommended workflow: codeyam-editor
10+
11+
We strongly recommend making your change through codeyam-editor. It keeps the
12+
three things that have to stay in sync — code, tests, and scenarios — aligned
13+
automatically, so your change lands with its scenarios captured and its tests
14+
registered instead of drifting apart over time.
15+
16+
```bash
17+
# Clone the repo
18+
git clone https://github.com/codeyam-ai/tabcommand && cd tabcommand
19+
20+
# Install codeyam-editor
21+
npm install -g @codeyam-editor/codeyam-editor@latest
22+
23+
# Launch the editor (split-screen terminal + live preview)
24+
codeyam-editor editor
25+
```
26+
27+
codeyam-editor requires a subscription to Claude, Gemini, or Codex. Inside the
28+
editor you describe or make a change and it walks you through capturing the
29+
scenarios and tests that cover it, so nothing you contribute goes untested or
30+
unillustrated.
31+
32+
## Building and testing by hand
33+
34+
If you're working without the editor, the standard workflow is fully supported.
35+
Requires Node.js 22+.
36+
37+
```bash
38+
# Install dependencies
39+
npm install
40+
41+
# Run the test suite and the linter
42+
npm test
43+
npm run lint
44+
45+
# Build the extension
46+
npm run build
47+
```
48+
49+
To try your build in Chrome: open `chrome://extensions`, enable **Developer
50+
mode**, choose **Load unpacked**, and select the `build/` folder. After code
51+
changes, re-run `npm run build` and reload the extension to pick them up.
52+
53+
## Pull requests
54+
55+
1. Fork and create a topic branch off `main`.
56+
2. Make your change — ideally in codeyam-editor, so its scenarios and tests are
57+
captured and registered as you go.
58+
3. Ensure `npm test`, `npm run lint`, and `npm run build` all pass.
59+
4. Open a PR describing what changed and why.
60+
61+
## Code of conduct
62+
63+
Please keep interactions respectful and constructive; by participating you
64+
agree to help keep this a welcoming community. To report a security issue, see
65+
[SECURITY.md](SECURITY.md).

0 commit comments

Comments
 (0)