Skip to content

Latest commit

 

History

History
133 lines (80 loc) · 3.97 KB

CONTRIBUTING.rst

File metadata and controls

133 lines (80 loc) · 3.97 KB
Raw

Contributing

First off, thanks for taking the time to contribute, everyone is welcome to contribute.

This project is hosted on https://github.com/probabl-ai/skore.

Below are some guidelines to help you get started.

Questions, bugs and feature requests

If you have any questions, feel free to reach out:

Both bugs and feature requests can be filed in the Github issue tracker:

Development

Quick start

You'll need python >=3.9, <3.13 to build the backend and Node>=20 to build the skore-ui. Then, you can install dependencies and run the UI with:

make install-skore
make build-skore-ui
make serve-skore-ui

You are now all setup to run the library locally. If you want to contribute, please continue with the three other sections.

Backend

Install backend dependencies with:

make install-skore

You can run the API server with:

make serve-skore-ui

skore-ui

Install skore-ui dependencies with:

npm install

in the skore-ui directory.

Run the skore-ui in dev mode (for hot-reloading) with

npm run dev

in the skore-ui directory.

Then, to use the skore-ui

make build-skore-ui
make serve-skore-ui

PR format

We use the conventional commits format, and we automatically check that the PR title fits this format. In particular, commits are "sentence case", meaning "fix: Fix issue" passes, while "fix: fix issue" doesn't.

Generally the description of a commit should start with a verb in the imperative voice, so that it would properly complete the sentence: "When applied, this commit will [...]".

Examples of correct PR titles: docs: Update the docstrings or feat: Remove CrossValidationAggregationItem.

Documentation

Setup

Our documentation uses PyData Sphinx Theme.

Warning

Modifications are to be done in the sphinx folder. The docs folder must not be touched!

To build the docs:

cd sphinx
make html

Then, you can access the local build via:

open build/html/index.html

Contributing to the docstrings

When writing documentation, whether it be online, docstrings or help messages in the CLI and in the UI, we strive to follow some conventions that are listed below. These might be updated as time goes on.

  1. The docstring will be compiled using Sphinx numpydoc so use RST (ReStructured Text) for bold, URLs, etc.
  2. Argument descriptions should be written so that the following sentence makes sense: Argument <argument> designates <argument description>
  3. Argument descriptions start with lower case, and do not end with a period or other punctuation
  4. Argument descriptions start with "the" where relevant, and "whether" for booleans
  5. Text is written in US english ("visualize" rather than "visualise")
  6. In the CLI, positional arguments are written in snake case (snake_case), keyword arguments in kebab case (kebab-case)
  7. When there is a default argument, it should be shown in the help message, typically with (default: <default value>) at the end of the message