Vegas

Contribution Guide

If this is the first time you work with this repository, follow the instructions below to clone the repository.

Fork this repo
Clone your repo (this will create a git remote called origin)

Add this repo as a remote:

git remote add upstream https://github.com/QEDjl-project/Vegas.jl

This will ensure that you have two remotes in your git: origin and upstream. You will create branches and push to origin, and you will fetch and update your local main branch from upstream.

Linting and formatting

Install a plugin on your editor to use EditorConfig. This will ensure that your editor is configured with important formatting settings.

To format the Julia code, we are using Runic.jl, so please install it globally first:

julia --startup-file=no -e 'using Pkg; Pkg.add("Runic")'

We recommend to use pre-commit. To install pre-commit, we recommend using pipx as follows:

# Install pipx following the link
pipx install pre-commit

With pre-commit installed, activate it as a pre-commit hook:

pre-commit install

To run the linting and formatting manually, enter the command below:

pre-commit run -a

Testing

As with most Julia packages, you can just open Julia in the repository folder, activate the environment, and run test:

julia --project

will open a julia REPL and activate the environment for Vegas.jl. Then you can run the tests locally by using the Pkg mode of the Julia REPL

julia> # press ]
pkg> test

To run the tests for specific backends, you need to set the following environmental variables:

TEST_<BACKEND> = 1 julia --project

for one of BACKEND=[CPU, CUDA, AMDGPU, METAL, ONEAPI].

Working on a new issue

We try to keep a linear history in this repo, so it is important to keep your branches up-to-date.

Fetch from the remote and fast-forward your local main

git fetch upstream
git switch main
git merge --ff-only upstream/main

Branch from main to address the issue (see below for naming)
```
git switch -c 42-add-answer-universe
```
Push the new local branch to your personal remote repository
```
git push -u origin 42-add-answer-universe
```
Create a pull request to merge your remote branch into the org main.

Before creating a pull request

Make sure the tests pass locally.
Make sure the formatter pass.
Fetch any main updates from upstream and rebase your branch, if necessary:
```
git fetch upstream
git rebase upstream/main BRANCH_NAME
```
Then you can open a pull request and work with the reviewer to address any issues.

Building and viewing the documentation locally

Following the latest suggestions, we recommend using LiveServer to build the documentation. Here is how you do it:

Run julia --project=docs to open Julia in the environment of the docs.
If this is the first time building the docs
1. Press ] to enter pkg mode
2. Run pkg> dev . to use the development version of your package
3. Press backspace to leave pkg mode
Run julia> using LiveServer
Run julia> servedocs()