Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.78 KB

Wspolpraca przy Praxis

Praxis to dobro wspolne. Buduje sie je wspolnie - dlatego uwagi i poprawki sa mile widziane. Ten dokument opisuje, jak je zglaszac i jak je przyjmujemy.

Jak zglosic uwage

  • Issue - blad, brak, watpliwosc, propozycja nowego przewodnika lub nowego narzedzia w istniejacym. Najprostsza forma - opisz rzecz, nie musisz proponowac rozwiazania.
  • Pull Request - konkretna poprawka tekstu, struktury, przykladu, checklisty.

Co przyjmujemy chetnie i szybko

  • Poprawki literowek, jezyka, formatowania.
  • Korekty faktow (z podaniem zrodla).
  • Lepsze przyklady, brakujace pulapki, doprecyzowanie krokow procedury.
  • Nowe narzedzia open source warte dolaczenia do przewodnika.
  • Zgloszenia nieaktualnych informacji (wersje narzedzi, zmiany w nich).

Bramka redakcyjna - zmiany w interpretacji prawnej

Przewodniki Praxis dotykaja RODO, AI Act i tajemnicy zawodowej. Pull Requesty zmieniajace interpretacje prawna (nie fakt, nie literowke - interpretacje) przechodza przez review redakcyjne MateMatic przed scaleniem. To nie zamkniecie wspolpracy - to ochrona czytelnika przed bledna teza prawna wstawiona pod marka MateMatic. W takim PR opisz proponowana zmiane i uzasadnienie; odniesiemy sie merytorycznie.

Wszystkie odniesienia prawne w przewodnikach to interpretacja MateMatic, nie stanowisko NRA ani KRRP. Ta zasada obowiazuje takze wklad zewnetrzny.

Ton i styl

  • Polski, konkretny, bez marketingowego belkotu.
  • Lacznik -, nigdy em-dash. Cudzyslowy polskie „...".
  • Krok procedury = jedno dzialanie. Konkret zamiast ogolnika.

Licencja wkladu

Zglaszajac Pull Request, zgadzasz sie na opublikowanie wkladu na licencji repozytorium - CC BY-SA 4.0.

Kontakt

Sprawy niepasujace do Issue/PR: kontakt@matematic.co.