An open-source home for quant education

The MIT License (MIT)

Copyright (c) 2026 Trading Dev Academy contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

# Contributing to Trading Dev Academy

Trading Dev Academy is a free, open-source quantitative finance education project. Contributions to accessibility, explanations, mathematical accuracy, Python examples and performance are welcome.

## Set up

Extract the source ZIP, install Node.js 22.13+ and run `npm ci`, `npm run release:source`, then `npm start`. Open http://127.0.0.1:8000. Python 3.10+ and NumPy are needed for numerical validation. Core learning runs without external API credentials. Optional research ingestion is documented separately in docs/paper-ingestion.md.

## Make a focused change

Explain the problem, intended behavior and how you checked the result. For a bug, include the route, browser, steps to reproduce and expected result. For a UI change, include desktop and mobile screenshots. Keep existing learning activities accessible and preserve module, lesson and practice IDs and browser storage keys.

Follow AGENTS.md for curriculum work: review primary research, record provenance and limitations, define notation locally, and pair equations with explicit hand calculations, numerical examples and self-contained Python. Synthetic examples demonstrate mechanics, not investment performance.

## Validate

Run `npm test`. With the local server running and Playwright installed, run:

```
node scripts/run-browser-checks.mjs tests/browser-smoke.js tests/browser-readings.js tests/browser-practice.js tests/browser-open-site.js
```

Set PLAYWRIGHT_MODULE and PLAYWRIGHT_EXECUTABLE if using a separately installed browser runtime. Browser checks use isolated contexts. Deployment changes also require `python3 -m unittest discover -s deploy/tradingdevacademy/tests` and the affected kit's documented checks.

## Share changes

A public repository has not yet been configured. Until a canonical repository is published, distribute a focused patch or modified source archive through your existing maintainer contact. Do not include credentials, operational state, learner notes or local database files. Security reports should follow SECURITY.md.

## Source releases and licensing

Run `npm run release:source` after source edits. New source files must be reviewed and explicitly added to scripts/source-release-files.json. The download includes its own manifest and excludes installed dependencies and local state. Keep third-party notices intact and document new dependencies or externally sourced material. By contributing original work, you agree to make it available under the project's MIT license; identify any material governed by other terms.

# Third-party notices

The root MIT license applies to original Trading Dev Academy code and original educational material. It does not replace the terms of third-party components, research or data.

- **Temml**: vendor/temml.min.js, css/temml.css and css/Temml.woff2 are from the Temml project. Copyright (c) 2020 Ron Kok, MIT. The font is a remapping of KaTeX_Script-Regular, as documented in css/temml.css. Full notice: vendor/Temml-LICENSE.txt. Source: https://github.com/ronkok/Temml.
- **KaTeX**: Temml derives from KaTeX. Copyright (c) 2013–2020 Khan Academy and other contributors, MIT. Full notice: vendor/KaTeX-LICENSE.txt. Source: https://github.com/KaTeX/KaTeX.
- **Installed dependencies**: package-lock.json records the npm dependency graph. Packages installed by npm ci retain their upstream licenses. The source ZIP does not bundle node_modules. The optional @google/genai SDK is Apache-2.0 licensed; its notice is distributed with the installed package.
- **Research and market data**: cited papers, quotations, abstracts, source metadata, and externally sourced datasets retain their authors' or providers' rights. Links and citations do not transfer ownership or grant redistribution rights. Consult source records in content/sources/, content/papers/ and dataset provenance in content/datasets/ before reusing these materials. The project MIT license does not relicense them.

License notices checked against the upstream Temml and KaTeX repositories on 8 October 2026. Preserve these notices in redistributions.