Skip to content

Commit

Permalink
Update 0001-define-code-style.md
Browse files Browse the repository at this point in the history
  • Loading branch information
oriolpiera authored Feb 1, 2024
1 parent 25d5e59 commit e046b49
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/adr/0001-define-code-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ _Permetem 'star imports' als fitxers `__init__.py` per no haver d'importar un pe

Pel que fa a formatar el codi al desenvolupar és una decisió pròpia de cada persona desenvolupadora. Dues formes en les quals es podria fer són les següents (o fer servir les dues alhora):

**Integrat amb VSCode**
#### Integrat amb VSCode

1. Instal·lem l'extensió de Python
2. Instal·lem `autopep8` (1.5.7) i `flake8` (3.9.2) al `venv` de `erp`
Expand All @@ -70,7 +70,7 @@ Pel que fa a formatar el codi al desenvolupar és una decisió pròpia de cada p

Al programar veurem els errors que ens marca `flake8` i al guardar se'ns formata automàticament el codi amb `autopep8`. Aquestes dues eines tindran en compte la configuració dels fitxers `.flake8` i `.pycodestyle` del repositori.

**Amb l'eina `pre-commit`**
#### Amb l'eina `pre-commit

1. Instal·lem `pre-commit` al `venv` de `erp`: `pip install pre-commit`
2. Activem el `pre-commit` dins el repositori: `pre-commit install`
Expand All @@ -81,6 +81,10 @@ Al fer un _commit_ ens formatarà el codi automàticament amb `autoflake` i `aut
- Els fitxers modificats pel `pre-commit` queden _unstaged_.
- Fa el mateix que farà el GitHub Actions (definit al fitxer `.pre-commit-config.yaml`).

#### Amb l'eina `pre-commit manualment, sense força que es passi al fer cada commit
1.- Anem a la carpeta del repositori
2.- Executem `pre-commit run -a`

## Conseqüències

El codi del repositori quedaria més net, més llegible i més uniforme. S'ha de fer un format de tot el repositori abans de començar a aplicar-ho.

0 comments on commit e046b49

Please sign in to comment.