Contributing guidelines

This document defines the conventions to follow when contributing (changing, updating) the website.

Overview

The website (.html) is created using Quarto and hosted on GitHub Pages. Useful references to check are: - Quarto documentation: how to build websites - Quarto documentation: how to publish websites using GitHub Pages - GitHub Pages documentation for details

Commit messages

We follow Conventional Commits notation.

Format

type(scope): short description
  • type: one of the allowed types below (required)
  • scope: the affected section, e.g. team, publications, homepage (optional)
  • description: imperative mood, present tense (“add”, not “added”/“adds”), no trailing period

Types

Type Description Examples
feat A new feature or content addition feat: add publications page
feat(team): add new PhD student profile
fix A bug fix or correction fix: broken image link in about page
fix(team): correct typo in member bio
docs Documentation-only changes docs: update contributing guidelines
docs(readme): fix instructions
style Formatting changes with no logic impact (whitespace, CSS, layout) style: fix inconsistent indentation
style(homepage): align navbar items
chore Other tasks (init, dependencies, config, build tools) chore: update dependencies
chore(ci): fix GitHub Actions workflow

A complete cheatsheet with more types and examples is available here.