Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.73 KB

Contributing

Thank you for your interest in contributing to usethis! There are issues labeled Good First Issue which are good opportunities for new contributors.

Since usethis is at early stages of development, please ensure a GitHub Issue is opened before starting work on a new feature or bug fix. This helps to ensure that the feature is aligned with the project's goals and that there is no duplication of effort.

Setup

uv is required to install the development environment. You can install it using the instructions here:

https://docs.astral.sh/uv/getting-started/installation/

Then with the current working directory set to the project root, run:

uv sync

Testing

To run the tests, simply run:

uv run pytest

Documentation

Documentation is hosted at https://usethis.readthedocs.io/en/latest/. It can be served locally with:

uv run mkdocs serve

Docstrings use Google Style.

Version Control

Git is used for version control, using Trunk-based development.

It is recommended that you use signed commits, although this is not a requirement. Please see this guide from the VS Code project for instructions on how to do this: https://github.com/microsoft/vscode/wiki/Commit-Signing

Architecture

This project uses Import Linter to enforce a software architecture. Refer to the [[tool.importlinter.contracts]] sections in pyproject.toml to understand the structure of the project.