apache/incubator-resilientdb-python-sdk

Add black formatting github hook

Open

#19 opened on Dec 13, 2023

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Python (6 forks)auto 404
good first issue

Repository metrics

Stars
 (6 stars)
PR merge metrics
 (PR metrics pending)

Description

https://towardsdatascience.com/keep-your-code-clean-using-black-pylint-git-hooks-pre-commit-baf6991f7376

Expected behavior: add a pre-commit hook which does the following

  • Check for formatting issue when git commit is used.
  • runs black to format if issue is found else exits

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.