trezor-firmware/README.md

Trezor Firmware

Repository Structure

• ci: Gitlab CI configuration files
• common/defs: JSON coin definitions and support tables
• common/protob: Common protobuf definitions for the Trezor protocol
• common/tools: Tools for managing coin definitions and related data
• core: Trezor Core, firmware implementation for Trezor T
• crypto: Stand-alone cryptography library used by both Trezor Core and the Trezor One firmware
• docs: Assorted documentation
• legacy: Trezor One firmware implementation
• python: Python client library and the trezorctl command
• storage: NORCOW storage implementation used by both Trezor Core and the Trezor One firmware
• tests: Firmware unit test suite
• tools: Miscellaneous build and helper scripts
• vendor: Submodules for external dependencies

Contribute

Inspired by GitLab Contributing Guide

Make sure to check out general contribution guidelines on the Trezor Wiki. If you are contributing to Trezor Core (the Trezor T firmware), make sure to check out Trezor Core contribution guidelines as well.

Some useful assorted knowledge can be found in the docs subdirectory.

Security vulnerability disclosure

Please report suspected security vulnerabilities in private to security@satoshilabs.com, also see the disclosure section on the Trezor.io website. Please do NOT create publicly viewable issues for suspected security vulnerabilities.

Issue Labels

Priority

Label	Meaning (SLA)
P1 Urgent	The current release + potentially immediate hotfix (30 days)
P2 High	The next release (60 days)
P3 Medium	Within the next 3 releases (90 days)
P4 Low	Anything outside the next 3 releases (120 days)

Severity

Label	Impact
S1 Blocker	Outage, broken feature with no workaround
S2 Critical	Broken feature, workaround too complex & unacceptable
S3 Major	Broken feature, workaround acceptable
S4 Low	Functionality inconvenience or cosmetic issue

CI

The complete test suite is running on a public GitLab CI. If you are an external contributor, we also have a Travis instance where a small subset of tests is running as well - mostly style and easy fast checks, which are quite common to fail for new contributors.