Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (53 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

85 lines (53 loc) · 2.81 KB

Contribution Guidelines

Contributions are welcome and these should ideally be made through the main repository on GitLab.

Local Development

This package facilitates MicroPython development in VSCode through the settings in .vscode and the micropython-stdlib-stubs project dev dependency. Type hints on MicroPython code are enabled through the following files, which are included as a package dependency and installed to the device lib/ directory:

New Issues; Bugs & Features

Features

Choose a suitable title and use a story format that explains the feature in depth:

As a [developer | user | system], instead of [current situation], I want [action | feature], so that [value | justification].

Issue description templates can help provide a useful format and context:

issue example

Full example:

issue example

Bugs

Use the New Bug description template when creating issues related to bugs:

issue example

Cloning The Repository

This repository is managed by Astral uv Python package manager and can be installed by cloning the repository and syncing with uv.

git clone git@gitlab.com:micropython-iot-projects/libraries/micropython-network-utils.git
cd micropython-network-utils
uv sync --all-extras

Activate the virtual environment created by uv:

source .venv/bin/activate

Linting & Formatting

With the virtual environment activated, the ruff check & format commands will implement the rules set in the pyproject.toml file. These tool can be also be run using the commands uv run ruff check or uv run ruff format.

To format the code in accordance with the project formatting rules, use the following command:

ruff format

To run the ruff linting tool, use the following command:

ruff check --fix

Commit Messages

Commit messages use the conventional commits specification:

<type>[optional scope]: <description>

git commit -m "docs: update contribution guidelines."
git commit -m "chore: ruff lint & format."
git commit -m "feat: add new mqtt extension package module."
git commit -m "fix: patch an installation error for cli install command #1234."

A breaking change is indicated with a '!':

git commit -m "refactor!: drop support for rshell."