CONTRIBUTING.md

Contributing to Xeus

Xeus and xeus-zmq are subprojects of Project Jupyter and subject to the Jupyter governance and Code of conduct.

General Guidelines

For general documentation about contributing to Jupyter projects, see the Project Jupyter Contributor Documentation.

Community

The Xeus team organizes public video meetings. The schedule for future meetings and minutes of past meetings can be found on our team compass.

Setting up a development environment

First, you need to fork the project. Then setup your environment:

# create a new conda environment
conda create -f environment-dev.yml
conda activate xeus-zmq

# download Xeus from your GitHub fork
git clone https://github.com/<your-github-username>/xeus-zmq.git

You may also want to install a C++ compiler, cmake, and pkg-config from conda if they are not available on your system. Pkg-config is required at build time for locating zeromq and OpenSSL.

Building and installing xeus-zmq

# Create a directory for building
mkdir build && cd build
# Generate the makefile with cmake
cmake -D CMAKE_BUILD_TYPE=Release -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib -D XEUS_ZMQ_BUILD_TESTS=ON ..
# Build and install
make install -j2

Running the tests

To run ctests, from the build directory, type

cd build/test
ctest --output-on-failure