Choose a coding style - Githubissues

ChalmersGU-data-structure-courses / lab-system

Lab system and other scripts for grading and course administration (Canvas and GitLab integration). Currently used by the CSE department at Chalmers and GU for several courses, including data structures and algorithms.

0 stars 0 forks source link

Choose a coding style #31

Open sattlerc opened 2 weeks ago

sattlerc commented 2 weeks ago

Maybe just Black?

sattlerc commented 1 week ago

I chose Black and reformatted the codebase (excluding deprecated files). Afterwards, I went through the codebase manually to improve some of the formatting.

In the process of this, I also fixed a bunch of minor problems, including some warnings produced by the linter. Those are in the following commits.

The convention of using Black is now documented in CONTRIBUTING.md. The invariant is that running black does not change any file.

sattlerc commented 1 week ago

I chose the tool isort to format import blocks.

sattlerc commented 1 week ago

We still need to decide on:

What linter(s) to use/support,
Which linter warnings to disable.

We should add configuration files for these tools to the repository root.