Contributing

pyxel-config-core lives in the Pyxel Config Lab repository, beside the browser app that reads the same bundled contract.

• The contributing guide explains how changes are proposed and reviewed.

• Everyone taking part follows the Code of Conduct.

• Bugs and ideas are welcome in the issue tracker.

Running the package’s tests

From the repository root:

pip install -e "./pyxel-config-core[dev]"
pytest pyxel-config-core/tests

The tests that run a config through Pyxel itself skip when Pyxel is not installed; pip install pyxel-sim runs them too.

Building these docs

pip install -e "./pyxel-config-core[docs]"
sphinx-build -W --keep-going -b html pyxel-config-core/docs docs-site/docs

Then open docs-site/docs/index.html. Most guide pages include a section of the package README, so a change to the README shows up here on the next build.