Creating a Pull Request¶
All code contributions to ProbNum should be made via pull requests (PR) to the main branch on GitHub.
To ensure a smooth workflow, please keep PRs as compact as possible. Each PR should only contain one enhancement at a time. If you implemented multiple changes, split them into several PRs.
Code quality is an essential component in a collaborative open-source project.
Make sure to observe good coding practice.
New dependencies should only be added with care.
All code should be covered by tests within the pytest framework.
Documentation of code is essential. ProbNum uses the NumPy docstring format.
Code follows the internal style guide.
To make life more simple, code should be formatted with Black.
Black is a simple code formatter. Install Black with
$ pip install black
Format a single Python file.
$ black my-file.py
Black takes care of most of the PEP8 formatting rules. Formatting with Black can also be done via tox.
Forking the Repo¶
In order to do pull requests, begin by forking the repository on GitHub. Then, clone your fork to a local machine.
$ git clone firstname.lastname@example.org:MyGithubAccount/probnum.git
In order to keep your fork up-to-date with the main repository, one convenient
way to do so is to set up multiple remotes
For example, this way you can always keep the main branch of your forked repository
up-to-date with the ProbNum repository and you can easily
git merge recent changes into your feature branch. To set up the ProbNum repository as a secondary remote run
$ cd probnum $ git remote add upstream https://github.com/probabilistic-numerics/probnum
Now in addition to
origin, which is your fork of ProbNum, you have access to the main
upstream. Check your remotes are set up properly by executing the following command.
$ git remote -v origin https://github.com/MyGithubAccount/probnum.git (fetch) origin https://github.com/MyGithubAccount/probnum.git (push) upstream https://github.com/probabilistic-numerics/probnum (fetch) upstream https://github.com/probabilistic-numerics/probnum (push)
Fetch and checkout the main branch of ProbNum.
Since there exists already a local
main branch tracking the main branch of your fork, we will name this one
probnum-main which tracks the main branch of
$ git fetch upstream $ git checkout -b probnum-main upstream/main
Next, create a new branch describing the feature you would like to implement.
$ git checkout -b my-new-feature
You can now get started writing code in your new branch.
Commit your changes to this local branch. Make sure to keep the best practices regarding code quality in mind. Next, set up a branch on your fork which is tracked by your local branch.
git push --set-upstream origin my-new-feature
Once in a while, merge changes of the upstream main branch into your local
$ git checkout probnum-main $ git pull $ git checkout my-new-feature $ git merge probnum-main
Creating a Pull-Request¶
Once you are happy with your PR, make sure your branch is up-to-date with upstream
main, and re-run all tests.
Then, from your local branch, push the changes to your remote branch
$ git push
and create the PR via the GitHub interface. There, briefly explain the changes. That’s it! If possible, please try running the test suite with tox or pytest before creating the PR.
Virtual environments (venvs) help you to get a separate, clean installation of ProbNum. Each venv uses a specific Python version. Venvs are useful as you may need different Python versions and dependencies for different projects. So, first make sure that you are using the correct Python version, and also that your pip installation is up to date.
Install the virtualenv package.
$ pip install virtualenv
Go to the probnum root directory.
Then, create a virtual environment with the name
This uses the Python version the
python alias is linked to.
$ python -m venv venv_probnum
Activate the venv (the command below works for bash, other shells might require a different command).
$ source venv_probnum/bin/activate
Check if your venv uses the correct Python path and Python version.
(The Python path should show something like this
$ which python $ python --version
You can deactivate the venv as well.
Install ProbNum in your environment (activate it first).
$ pip install -e .
If needed, install additional requirements, e.g., for testing.
$ pip install -e .[test]
Check your installation with
It is possible to create virtual environments with most modern editors such as e.g., PyCharm. Alternatively, you can add the venv you created above to your project in the editor.
Tests are run with the pytest package.
Make sure ProbNum is installed including test requirements (
pip install -e .[test])) in your virtual
environment; installing ProbNum that way will already have installed pytest.
(If you are unsure, use
pip freeze to check the installation in your active venv).
Run tests with the Python version in the venv.
This should normally be enough to catch the biggest bugs. If you want to run the whole testsuite for several Python versions, the preferred way is to use tox.
Probnum uses tox in its continuous integration (CI)
pipeline to run tests, build documentation, check code formatting and code quality. Under the hood, tox builds virtual
environments following the specifications in
./tox.ini in order to run tests across multiple Python versions, while
making sure that all the necessary dependencies are installed. Using tox unifies the
local development process with continuous integration builds (via GitHub Actions),
such that local test results should match the outcomes of the CI builds more closely.
This ensures that your pull request can be merged seamlessly into ProbNum’s codebase.
Install tox from the Python Package Index (PyPI) via
$ pip install -U tox
Some commands, such as building the documentation locally, requires additional packages
(e.g., for inheritance diagrams). These are
.github/workflows/CI-build.yml. These packages are currently:
pandoc: In Ubuntu, install via
sudo apt install pandoc
graphviz: In Ubuntu, install via
sudo apt install graphviz
In order to run tox smoothly, please install those as well.
Now, you can run all tests and build the documentation locally by simply calling
To reduce runtime, tox caches and reuses the virtual environment it creates the first time you run the command. If
you are frequently switching between branches or adjusting the build configuration make sure to force recreation of the
virtual environment via
Additionally, the command
tox runs all environments as specified in
tox.ini, thus potentially running tests across many different
Python versions. To run the full test suite make sure that you have all specified Python versions installed.
Alternatively, you can run a single specific environment through
tox -e <env>. Useful examples are:
Full test suite with tox: Run the full suite across different Python versions with
Single environment with tox: Run tests for a single Python environment, e.g. for Python 3.8
$ tox -e py38
Single environment with tox: only build the documentation.
$ tox -e docs
Code coverage of the tests is reported via codecov.
You can build the documentation locally via
$ tox -e docs
This creates a static web page under
./docs/_build/html/ which you can view in your browser by opening
Alternatively, if you want to build the docs in your current environment you can manually execute
$ cd docs $ make clean $ make html
ProbNum uses Github Actions for continuous integration.
For every pull request and every commit the project is built, the test suite is run,
the documentation is built, the benchmarks are dry-run, the code is linted and
checked for consistency with the Black code style.
This ensures that no breaking changes are introduced by mistake. Changes to
Github Actions can be made in the
.github/workflows/ folder, as well as in
tox.ini since Github Actions rely on
tox for all the above checks.
If you regularly write code for ProbNum, pre-commit hoods might be useful.
Pre-commit hooks allow the automatic identification of simple issues in a commit, e.g.
inconsistent code formatting. They are
executed automatically whenever
git commit is executed. This way one can avoid common
problems in a pull request which prevent an automatic merge into the
main branch on
GitHub. To set up ProbNum’s pre-commit hooks simply install pre-commit by executing
$ pip install pre-commit
and install the provided configuration file
.pre-commit-config.yaml with a recommended
set of pre-commit hooks via
$ pre-commit install