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
Align documentation with the current QTI 2.x/3.0 project scope, capture the review baseline, and remove obsolete planning artifacts.
Co-authored-by: Cursor <cursoragent@cursor.com>
-**`packages/player-elements/`** - Web component wrappers
57
+
-**`tools/cli/`** - Transform and analysis CLI
49
58
-**`apps/demo/`** - Demo application
59
+
-**`apps/docs/`** - Published docs site
50
60
-**`apps/transform/`** - Internal transform reference harness; not part of supported app CI
51
61
52
62
## Code Standards
@@ -67,9 +77,9 @@ This is a monorepo with multiple packages:
67
77
68
78
- Write tests for new features
69
79
- Maintain existing test coverage
70
-
- Run tests with `bun test`
80
+
- Run tests with `bun run test`
71
81
- For QTI certification-facing changes, run `bun run test:certification:public`
72
-
- E2E tests: `bun run test:e2e` (requires dev server running)
82
+
- E2E tests: `bun run test:e2e` (Playwright starts the demo server unless `PLAYWRIGHT_REUSE_EXISTING_SERVER=true`)
73
83
74
84
### Commits
75
85
@@ -79,17 +89,18 @@ This is a monorepo with multiple packages:
79
89
80
90
## Pull Request Process
81
91
82
-
1.**Fork the repository** and create a branch from `main`
92
+
1.**Fork the repository** and create a branch from `master`
83
93
84
94
2.**Make your changes**
85
95
- Follow code standards
86
96
- Add tests for new functionality
87
97
- Update documentation as needed
88
98
89
99
3.**Test your changes**
100
+
90
101
```bash
91
102
bun run build
92
-
bun test
103
+
bun run test
93
104
bun run test:certification:public # Required for QTI delivery behavior changes
94
105
bun run test:e2e # If applicable
95
106
```
@@ -108,11 +119,11 @@ This is a monorepo with multiple packages:
108
119
109
120
### Adding New Interaction Types
110
121
111
-
1.Create processor in `packages/item-player/src/processors/`
112
-
2. Add Svelte component in `packages/item-player/src/components/`
113
-
3.Update `InlineInteractionRenderer.svelte` or `BlockInteractionRenderer.svelte`
114
-
4. Add tests in `packages/item-player/tests/processors/`
115
-
5. Update documentation in README
122
+
1.Add extraction and data-model support under `packages/item-player/src/interactions/<interaction>/`.
123
+
2. Add the default Svelte custom element under `packages/default-components/src/plugins/<interaction>/`.
124
+
3.Register the interaction in the item-player interaction modules and the default-components plugin index.
125
+
4. Add extractor, component, and browser-visible tests that cover the interaction's QTI attributes and response semantics.
126
+
5. Update the relevant README, PRD, eval YAML, and certification matrix entries when behavior or coverage changes.
116
127
117
128
### Fixing Bugs
118
129
@@ -129,7 +140,7 @@ This is a monorepo with multiple packages:
129
140
130
141
## Security
131
142
132
-
If you discover a security vulnerability, please follow our [Security Policy](SECURITY.md)for responsible disclosure.
143
+
If you discover a security vulnerability, please follow the security model in [docs/prds/architecture/security.md](docs/prds/architecture/security.md)and contact the maintainers privately before opening a public issue.
Copy file name to clipboardExpand all lines: README.md
+24-19Lines changed: 24 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,15 +30,15 @@ This project provides two major capabilities:
30
30
31
31
Many Renaissance partners exchange content in **QTI format**, so bidirectional QTI ↔ PIE transformation is essential. This project **open sources that transformation framework** for partners and the broader community.
32
32
33
-
We also built a **spec-complete QTI player** because a modern, open-source option was missing—and we needed one for previewing, analysis, and "convert then render" workflows.
33
+
We also built a **standards-oriented QTI player** because a modern, open-source option was missing—and we needed one for previewing, analysis, and "convert then render" workflows.
> **Status**: Production-ready for the supported QTI delivery scope; QTI 3.0 infrastructure, PCI, PNP, and Catalog support are implemented (see STATUS.md)
40
40
41
-
Full-featured players for rendering QTI 2.2 and 3.0 assessment content in the browser.
41
+
Full-featured players for rendering QTI assessment content in the browser.
42
42
43
43
### Version-Agnostic Architecture
44
44
@@ -55,7 +55,7 @@ See [`@pie-qti/qti-common`](packages/qti-common/README.md) for the version abstr
55
55
56
56
Renders and scores individual QTI items:
57
57
58
-
-**21 interaction types** — All QTI 2.2 interactions supported
58
+
-**21 standard interaction types** — Standard QTI interactions supported through the shared extraction/rendering path
0 commit comments