aibot88 Zrób porządek w projekcie.
Przebieg pracy:
- Zaktualizuj
ROADMAP.md:- statusy milestone'ów zgodnie z rzeczywistością
- Zaktualizuj
STATUS.md:- aktualny stan projektu
- istotne ograniczenia
- najbliższy sensowny następny krok, jeśli wynika z obecnego stanu
- Sprawdź
README.mdi zaktualizuj go tylko wtedy, gdy ostatnie zmiany wpływają na informacje istotne dla człowieka:- sposób uruchamiania
- wymagania
- komendy developerskie
- opis działania funkcji
- ograniczenia lub ważne zachowania systemu
- Upewnij się, że stan repo jest zapisany:
- jeśli są niezapisane zmiany dokumentacyjne wynikające z wrap-up, przygotuj commit
- jeśli nie ma zmian, nie twórz pustych commitów
Zasady:
- nie zmieniaj kodu
- nie aktualizuj
README.mdkosmetycznie ani bez realnej potrzeby - dokumentacja ma odzwierciedlać faktyczny stan repo
- jeśli potrzebujesz doprecyzowania zasad wrap-up albo README, użyj plików z
references/ - jeśli potrzebujesz technicznie sprawdzić stan repo, użyj skryptów z
scripts/
Wynik:
- podsumuj, które dokumenty zostały zaktualizowane
- zaznacz, czy powstał commit dokumentacyjny
- jeśli nic nie wymagało zmian, napisz to wprost