Note
Contributions that were generated in whole or in-part from any language model or AI, such as GitHub Copilot, ChatGPT, BARD, or any other such tool are explicitly forbidden and will result in your permanent ban from contributing to this project.
Contributions to Squishy are released under the following licenses depending on the component:
- CERN-OHL-S - Hardware
- CC-BY-SA - Documentation
Please note that Squishy is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Prior working on squishy, ensure you understand have have followed the general Installation guide, when installing Squishy make sure to add [dev] do the package name to ensure the needed development tools are installed along with squishy.
Alternatively, use pip to install nox, like so:
$ pip install nox
General testing and linting of Squishy is done with nox, as such there are some session names to know about:
test- Run the test suitelint- Run the lintertypecheck- Run the type-checker
Bye default these are configured to run one right after another when invoking nox with no arguments, to run a single check, you can run it with passing -s <session> to nox, like so:
$ nox -s lint
In addition to this, to work on the hardware, you need a copy of KiCad 7.0 or newer.