Verified Commit 2d84e731 authored by Maciej Rachuna's avatar Maciej Rachuna
Browse files

docs: Aktualizacja dokumentacji

parent 1b90b19a
Loading
Loading
Loading
Loading
Loading

CONTRIBUTING.md

0 → 100644
+50 −0
Original line number Diff line number Diff line
# Contributions

Dziękujemy za zainteresowanie i chęć wniesienia wkładu do tego projektu! Doceniamy Twój czas i wysiłek. Oto kilka wskazówek, które pomogą Ci zacząć.

## Jak wnieść wkład

1. **Zforkuj repozytorium**: Stwórz kopię tego repozytorium na swoim koncie GitLab, klikając przycisk „Fork” na górze.
2. **Sklonuj swojego forka**: Sklonuj zforkowane repozytorium na swój lokalny komputer za pomocą komendy:
   ```bash
   git clone https://gitlab.com/twoja-nazwa-użytkownika/nazwa-projektu.git
   ```
3. **Utwórz gałąź**: Stwórz nową gałąź dla swoich zmian:
   ```bash
   git checkout -b twoja-nazwa-gałęzi
   ```
4. **Wprowadź zmiany**: Zaimplementuj swoje zmiany w tej gałęzi.
5. **Przetestuj swoje zmiany**: Upewnij się, że Twoje zmiany działają poprawnie, uruchamiając odpowiednie testy lub skrypty projektu.
6. **Zacommituj swoje zmiany**: Napisz jasny komunikat commit, opisujący wprowadzone zmiany:
   ```bash
   git add .
   git commit -m "Opis zmian"
   ```
7. **Wyślij na GitLab**: Wyślij swoje zmiany do swojego forka:
   ```bash
   git push origin twoja-nazwa-gałęzi
   ```
8. **Utwórz Pull Request**: Otwórz pull request (PR) z Twojego forka do głównego repozytorium, wyjaśniając, co zrobiłeś i dlaczego jest to przydatne.

## Kodeks postępowania

Prosimy o szacunek i uwzględnienie innych podczas wniesienia wkładu. Wszyscy współtwórcy są zobowiązani do przestrzegania [Kodeksu Postępowania](CODE_OF_CONDUCT.md).

## Zgłaszanie problemów

Jeśli napotkasz błędy, masz sugestie lub coś jest niezrozumiałe, otwórz zgłoszenie w sekcji [Issues](https://gitlab.com/nazwa-projektu/issues) repozytorium. Podczas zgłaszania problemu prosimy o podanie:

- Jasnego opisu problemu.
- Kroków do odtworzenia problemu.
- Odpowiednich plików logów, komunikatów o błędach lub zrzutów ekranu.

## Wytyczne dotyczące commitów

- Używaj jasnych i zwięzłych komunikatów commit.
- Przestrzegaj specyfikacji [Conventional Commits](https://www.conventionalcommits.org/) dla opisów commitów:
  - `feat`: Nowa funkcja
  - `fix`: Poprawka błędu
  - `docs`: Zmiany w dokumentacji
  - `style`: Zmiany w stylu kodu (np. formatowanie)
  - `test`: Dodawanie lub aktualizacja testów
  - `refactor`: Refaktoryzacja kodu bez zmiany zachowania

LICENSE

0 → 100644
+46 −0
Original line number Diff line number Diff line
MIT License

Copyright (c) 2026 Maciej Rachuna

## ENG

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

## PL

Niniejszym udziela się bezpłatnie każdej osobie, która uzyskała kopię tego
oprogramowania i powiązanych plików dokumentacji (dalej zwanych
"Oprogramowaniem"), prawa do korzystania z Oprogramowania bez ograniczeń,
obejmującego w szczególności prawa do używania, kopiowania, modyfikowania,
łączenia, publikowania, rozpowszechniania, sublicencjonowania i/lub sprzedaży
kopii Oprogramowania, jak również do zezwalania osobom, którym Oprogramowanie
zostało dostarczone, na takie działania, z zastrzeżeniem następujących
warunków:

Powyższa informacja o prawach autorskich oraz niniejsze zezwolenie muszą być
zawarte we wszystkich kopiach lub istotnych częściach Oprogramowania.

OPROGRAMOWANIE JEST DOSTARCZANE "TAK JAK JEST", BEZ JAKIEJKOLWIEK GWARANCJI,
WYRAŹNEJ LUB DOROZUMIANEJ, W TYM MIĘDZY INNYMI GWARANCJI PRZYDATNOŚCI
HANDLOWEJ, PRZYDATNOŚCI DO OKREŚLONEGO CELU I NIENARUSZANIA PRAW. W ŻADNYM
WYPADKU AUTORZY LUB POSIADACZE PRAW AUTORSKICH NIE PONOSZĄ ODPOWIEDZIALNOŚCI
ZA JAKIEKOLWIEK ROSZCZENIA, SZKODY LUB INNE ZOBOWIĄZANIA, CZY TO WYNIKAJĄCE Z
UMOWY, CZYNU NIEDOZWOLONEGO CZY W JAKIKOLWIEK INNY SPOSÓB, POWSTAŁE W
ZWIĄZKU Z OPROGRAMOWANIEM LUB UŻYWANIEM OPROGRAMOWANIA LUB INNYMI
DZIAŁANIAMI W ZAKRESIE OPROGRAMOWANIA.
 No newline at end of file
+1 −3
Original line number Diff line number Diff line
@@ -38,14 +38,12 @@ query: type = Issue

---
## Contributions

Jeśli masz pomysły na ulepszenia, zgłoś problemy, rozwidl repozytorium lub utwórz Merge Request. Wszystkie wkłady są mile widziane!
[Contributions](CONTRIBUTING.md)

---
## License

Projekt jest udostępniany na warunkach licencji opisanych w pliku [LICENSE](LICENSE).
Projekt licencjonowany jest na warunkach [Licencji MIT](LICENSE).

---
# Author Information

assets/avatars/ja.png

0 → 100644
+2.03 MiB
Loading image diff...
+707 KiB
Loading image diff...