Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 1.78 KB
Raw

Contributing Guide

The following document describes how to contribute to this repository and the required setup for your development environment.

This repository is generated using copier. The template documentation explains how to generate and update this repository from the template.

Getting Started

The template repository provides a make-based development workflow that can be extended and customized per project.

The template documentation explains the default development workflow and all make targets in detail.

To get started quickly clone this repository and use make install check to install project dependencies and ensure that your development environment works.

The following system dependencies are are not managed by this repository and need to be installed manually.

  • docker or access to a working docker host
  • pre-commit to run formatting and linting
  • pipx to install global dependencies
  • direnv to ensure a working environment
  • copier to update this repository from the template
  • poetry to install Python project dependencies

Most dependencies can be installed using Homebrew:

brew install --cask docker
brew install pre-commit pipx direnv copier
brew install poetry

Once pre-commit hook is activated (make pre-commit-install), set of formatting and linting routines is run automatically on each commit. The step could be avoided by providing --no-verify flag for git commit.