Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

91 lines (64 loc) · 2.77 KB

Contributing guide

Bugs and feature requests

Both bugs and feature requests can be filed in the Github issue tracker, as well as general questions and feedback.

Bug reports are welcome, especially those reported with short, self-contained, correct examples.

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-api

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-ui

Documentation

To build the docs:

make build-doc

Then, you can access the local build via:

open doc/_build/html/index.html

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. Our custom set of rules is in commitlint.config.js.

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 [...]".

Contributing documentation

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. Argument descriptions should be written so that the following sentence makes sense: Argument <argument> designates <argument description>
  2. Argument descriptions start with lower case, and do not end with a period or other punctuation
  3. Argument descriptions start with "the" where relevant, and "whether" for booleans
  4. Text is written in US english ("visualize" rather than "visualise")
  5. In the CLI, positional arguments are written in snake case (snake_case), keyword arguments in kebab case (kebab-case)
  6. 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

Help for common issues

make build-skore-ui doesn't work!

Please check that your version of node is at least 20 using the following command: node -v