ProjektyUstaw / Ustawy-o-PIT

919 stars 45 forks source link

[Techniczne] package.json + markdown linter #115

Closed ctomczyk closed 1 year ago

ctomczyk commented 1 year ago

Sugerowałbym utworzenie package.json i dodatnie Markdown Linter: https://github.com/igorshubovych/markdownlint-cli#readme

To pozwoliłoby na utrzymanie spójnego formatu dokumentów markdown (.md).

czlowiek488 commented 1 year ago

Hmmm, zastanawiam się czy chcemy tworzyć package.json. Może github actions które na PR sprawdza markdown wystarczy, jak uważasz?

ctomczyk commented 1 year ago

Hmmm, zastanawiam się czy chcemy tworzyć package.json.

No też wolałbym uniknąć.

Może github actions które na PR sprawdza markdown wystarczy, jak uważasz?

GitHub Actions w zasadzie powinno wystarczyć.

AndrewDemski-ad-gmail-com commented 1 year ago

Wszystko pięknie, ale czy wtedy ktoś podejmie decyzję aby MD był od razu korygowany (R/W + PAT)?

potencjalne ryzyko: casus "lub czasopisma w wykonaniu automatu" Od razu proponuję ustawienie APPLY_FIXES na none

ctomczyk commented 1 year ago

potencjalne ryzyko: casus "lub czasopisma w wykonaniu automatu" Od razu proponuję ustawienie APPLY_FIXES na none

Wszystko pięknie, ale czy wtedy ktoś podejmie decyzję aby MD był od razu korygowany (R/W + PAT)?

Moim zdaniem nie powinno być automatycznej korekty. A jeśli już, to z automatycznym Pull Requestem, aby mimo wszystko przejrzeć dokonane zmiany i upewnić się, że wszystko jest w porządku.

Deathis commented 1 year ago

Proponuję skonfigurowanie CI, który uruchomiłby markdown linter w każdym PR. To rozwiązanie nie wymusza instalowania pluginów. Nie jestem zwolennikiem automatycznej korekty plików czytanych.

ctomczyk commented 1 year ago

Proponuję skonfigurowanie CI, który uruchomiłby markdown linter w każdym PR. To rozwiązanie nie wymusza instalowania pluginów. Nie jestem zwolennikiem automatycznej korekty plików czytanych.

Myślę, że GitHub Actions mogłoby być tutaj wykorzystane.

MacDada commented 1 year ago

Wykorzystujemy GitHub Actions do lintowania plików MD: https://github.com/ProjektyUstaw/Ustawy-o-PIT/blob/main/.github/workflows/md-lint.yml

Samo sprawdzanie, bez automatycznych poprawek, żeby uniknąć niespodzianek.

Dzięki za propozycje!