mirror of
https://github.com/trezor/trezor-firmware.git
synced 2024-11-26 09:28:13 +00:00
4c8c96272c
Click REALLY INSISTS you provide on/off switches for your options.
You can use is_flag, but then the presence of the option changes based
on the default value.
Which makes sense, really:
@option("-f", "foobar", is_flag=True, default=False)
you would expect `./cli -f` to have `foobar is True`
whereas with
@option("-f", "foobar", is_flag=True, default=True)
you would expect `./cli -f` to have `foobar is False`, otherwise it's a
no-op
this becomes fun with `default=os.environ.get("SOMETHING")`, because
then the effect of the option CHANGES with a value of environment
variable!
there's two ways around this:
a) don't use defaults, update the flag explicitly, like:
foobar = foobar or os.environ.get("FOOBAR") == "1"
b) forget about is_flag and specify an on/off switch, where the default
value works as intended
since the latter is also technically speaking more correct, i'm doing it
|
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| ci | ||
| common | ||
| core | ||
| crypto | ||
| docs | ||
| legacy | ||
| python | ||
| storage | ||
| tests | ||
| tools | ||
| vendor | ||
| .clang-format | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| .travis.yml | ||
| build-docker.sh | ||
| CONTRIBUTING.md | ||
| create_monorepo.py | ||
| Makefile | ||
| Pipfile | ||
| Pipfile.lock | ||
| README.md | ||
| SECURITY.md | ||
| setup.cfg | ||
| shell.nix | ||
Trezor Firmware
Repository Structure
ci: Gitlab CI configuration filescommon/defs: JSON coin definitions and support tablescommon/protob: Common protobuf definitions for the Trezor protocolcommon/tools: Tools for managing coin definitions and related datacore: Trezor Core, firmware implementation for Trezor Tcrypto: Stand-alone cryptography library used by both Trezor Core and the Trezor One firmwaredocs: Assorted documentationlegacy: Trezor One firmware implementationpython: Python client library and thetrezorctlcommandstorage: NORCOW storage implementation used by both Trezor Core and the Trezor One firmwaretests: Firmware unit test suitetools: Miscellaneous build and helper scriptsvendor: Submodules for external dependencies
Contribute
See CONTRIBUTING.md.
Also please have a look at the docs, either in the docs folder or at docs.trezor.io before contributing. The misc chapter should be read in particular because it contains some useful assorted knowledge.
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.
Documentation
See the docs folder or visit docs.trezor.io.