Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (46 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 1.81 KB

Contributing

Generating base stubs for module

You can generate stubs with tools/generate.py.

Usage:

$ uv run tools/generate.py -h
usage: generate.py [-h] [-u UPDATE] module version

Generate module stubs

positional arguments:
  module      Gdk, Gtk, ...
  version     3.0, 4.0, ...

options:
  -h, --help  show this help message and exit
  -u UPDATE   Stub file to update e.g. -u Gdk.pyi

Usage examples:

uv run ./tools/generate.py GtkSource 5 -u ./src/gi-stubs/repository/_GtkSource5.pyi
uv run ./tools/generate.py Spelling 1 -u ./src/gi-stubs/repository/Spelling.pyi
uv run pre-commit run --all

To re-generate all known stubs, run uv run ./tools/update_all.py. You can comment out the libraries you are not interested in.

Use pre-commit

pre-commit is a library which executes checks defined in this repository.

$ pre-commit install

Commit Messages

A good article regarding good commit messages

Every commit message must be prefixed with one of the following tags:

Changelog relevant

  • feat (a new feature was added)
  • fix (something was fixed)
  • imprv (improvements)
  • change (existing functionality was changed)
  • typing (whenever type hints are added to a module, Example: typing: GLib: Add hints)

Prefixes for development

  • new (new code, but the end user will not notice)
  • ci (ci related changes)
  • cq (code quality changes e.g. formatting, codestyle)
  • cfix (code fixes which should not show up in the changelog)
  • refactor (code was changed, but the end user will not notice)
  • chore (reoccuring tasks which need to be done)
  • release (only used for release commits)
  • other (everything which does not fit any categories)

Example:

feat: New Button which does something