CONTRIBUTING.md

Contributing to scip-python

• Development
  • Installing dependencies
  • Building the code
  • Running tests
• Publishing releases

Development

Installing dependencies

1. Install ASDF.

2. Install the correct versions of Node and Python:

   asdf plugin add nodejs
   asdf plugin add python
   # Install appropriate Node and Python versions based on .tool-versions
   asdf install

   You may need to restart your shell for the changes to take effect.

   NOTE: On Linux, ASDF may try to install Python from source instead of using prebuilt binaries. In that case, you need to install a bunch of other dependencies first:

   sudo apt update
   sudo apt install -y build-essential zlib1g-dev libssl-dev libbz2-dev libsqlite3-dev libncurses-dev libffi-dev readline-common libreadline-dev liblzma-dev

3. Install dependencies:

   # From the root of the repo
   npm install
   cd packages/pyright-scip
   npm install

All the other commands should be run from the packages/pyright-scip subdirectory.

Building the code

# Build in development mode once
npm run webpack

# Build in development mode, watch for changes
npm run watch

To create a release build:

npm run build

WARNING: If you create the release build and then try to run tests, you will not get useful stack traces because source maps are disabled for the release build.

All of the above methods should produce an index.js file in packages/pyright-scip which can be invoked with Node to index a test project.

node --enable-source-maps ./index.js <other args>

Running tests

npm run check-snapshots

WARNING: At the moment, there are some known test failures on macOS.

Using a different Python version other than the one specified in .tool-versions may also lead to errors.

Publishing releases

1. Change the version in packages/pyright-scip/package.json to M.N.P and land a PR with that.
2. Add a tag vM.N.P to the commit on the scip branch and push that tag.