Skip to content

Commit 682d31e

Browse files
committed
docs: Dodano więcej informacji do CONTRIBUTING
1 parent c0be372 commit 682d31e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Polski Frontend - pomoc mile widziana!
22

33
## Issues
4+
45
Zachęcamy do otwierania Issues ze znalezionymi bugami i z sugestiami tego, co można poprawić.
56

67
## Stack technologiczny
8+
79
- TypeScript
810
- Next.js (SSG, ISG)
911
- PostgreSQL
@@ -12,10 +14,13 @@ Zachęcamy do otwierania Issues ze znalezionymi bugami i z sugestiami tego, co m
1214
- Vercel
1315

1416
## Wymagania
17+
1518
- `yarn` w wersji co najmniej 1.22.x, ale mniejszej niż 2.x.x
1619
- Docker i polecenie `docker-compose`
1720

1821
## Praca lokalna
22+
23+
Przed przystąpieniem do pracy należy skopiować plik `.env-sample` do `.env`.
1924
Projekt uruchamiamy jednym poleceniem `yarn dev`. Spowoduje ono instalację wszystkich potrzebnych zależności, uruchomienie kontenera w Dockerze oraz nasze aplikacji.
2025
Po chwili powinna być gotowa pod adresem http://localhost:3000/
2126

@@ -28,6 +33,7 @@ docker exec -i polskifrontend_typeofweb_polskifrontend_1 psql polskifrontend -U
2833
Spowoduje to załadowanie danych do bazy z pliku DUMP.sql.
2934

3035
## Konwencje
36+
3137
Większość konwencji w projekcie jest wymuszona przez `prettier` i/lub `eslint` oraz TypeScripta.
3238

3339
Ważna uwaga odnośnie tworzenia Pull Requestów: Od 29. grudnia korzystamy z "Conventional Commits", aby łatwiej nam było generować CHANGELOG. **Nazwy commitów mogą być dowolne**, ale **tytuł samego PR-a musi spełniać określone wymagania**! Więcej informacji oraz przykłady można znaleźć tutaj: https://highlab.pl/conventional-commits/

0 commit comments

Comments
 (0)