Black formatting and pre-commit hooks - Githubissues

CornellNLP / ConvoKit

ConvoKit is a toolkit for extracting conversational features and analyzing social phenomena in conversations. It includes several large conversational datasets along with scripts exemplifying the use of the toolkit on these datasets.

https://convokit.cornell.edu/documentation/

MIT License

556 stars 129 forks source link

Black formatting and pre-commit hooks #163

Closed calebchiam closed 2 years ago

calebchiam commented 2 years ago

Description

Added Black formatting to standardize code style
Added pre-commit hooks to have Black run on every commit
Added GitHub workflow to check for formatting issues
Instructions for setting these tools up locally can be found in CONTRIBUTING.md

Motivation and Context

Developer time shouldn't be wasted on formatting issues when they can be taken care of automatically.

Black makes very sensible (and well liked) decisions for formatting for Python and will allow us to have much nicer formatted code going forward.

How has this been tested?

Not relevant. Ran it on entire repo.

Other information

Black can be integrated with any editor to auto-format files on every save.