search

LinkopingsStudentspex / internsidor

GNU General Public License v2.0
3 stars 0 forks source link

Kodstädning #62

Open jonatanskogsfors opened 2 months ago

jonatanskogsfors commented 2 months ago

Om det är ok skulle jag kunna tänka mig att göra en liten kodstädning.

I första hand tänker jag på models-modulen i batadasen som skulle kunna bli ett paket (mapp) istället med modellerna i egna (eller åtminstone mer grupperade) moduler.

Syftet skulle vara lätta upp strukturen lite så att det blir lite lättare för nytillkomna att få en översikt.

En annan lätt åtgärd är att applicera t.ex. ruff som automatisk formaterare och lintare så att koden blir enhetlig. Jag har en lista på 578 lintningsfel efter att ha provkört. På mina senaste GitHub-projekt har jag lagt till en github action som kör ruff och stoppar pullrequests som slarvat.

Allt som allt skulle det bli en pullrequest som inte ändrar på något beteende men som muckar lite med blame-historik.

Rovanion commented 2 months ago

För att inte störa blame-historik kan jag rekommendera skapandet av en fil .git-blame-ignore-revs i roten av källkodsträdet följt av att kommandot git config blame.ignoreRevsFile .git-blame-ignore-revs läggs till i instruktionerna för hur man sätter upp utvecklingsmiljön.

Rovanion commented 2 months ago

En sådan fil kan sedan se ut såhär:

# Since git version 2.23, git-blame has a feature to ignore
# certain commits.
#
# This file contains a list of commits that are not likely what
# you are looking for in `git blame`. You can set this file as
# a default ignore file for blame by running the following
# command.
#
# $ git config blame.ignoreRevsFile .git-blame-ignore-revs

# Indent Puppet code uniformly.
a461a6c642fe8e8fc13a2409f737e1c20fe20963
jonatanskogsfors commented 2 months ago

Spännande, det har jag aldrig testat förut. Ska läsa på lite.