swe-110-explain-a-codebase
/swe-110-explain-a-codebase
Czyta nieznany kod i wyjaśnia go człowiekowi bez zmian: jak działa projekt, gdzie coś się dzieje i jak go uruchomić.
- Autor
- fleetregistry ↗
- Repozytorium
- fleet-academy ↗
- Licencja
- Apache-2.0
- Ostatnia zmiana repozytorium
- 04.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 9
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 04.11.2026, bez odwołań do wycofanych modeli i API.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
Co robi i kiedy
Czyta nieznany kod i wyjaśnia go człowiekowi bez zmian: jak działa projekt, gdzie coś się dzieje i jak go uruchomić.
Oryginalny opis (EN)
Read an unfamiliar codebase and explain it to a person without changing anything. Use when asked how a project works, where something happens, or how to run it, and before any change to code you haven't read.
Jak działa
- 1. Get oriented (10 minutes, not 2 hours)
- 2. Trace one real path
- 3. Run only what's safe
- 4. Name the risky parts
- 5. Write the explanation
- When to stop and ask
Podgląd SKILL.md
--- name: swe-110-explain-a-codebase description: Read an unfamiliar codebase and explain it to a person without changing anything. Use when asked how a project works, where something happens, or how to run it, and before any change to code you haven't read. --- # Explain a Codebase You are reading, not changing. Nothing you do in this course should edit a file, create a branch, install into a shared environment, or touch a running system. ## 1. Get oriented (10 minutes, not 2 hours) 1. Read the README, any CONTRIBUTING or docs folder, and the top-level file list. 2. Find the manifest files (package.json, pyproject.toml, go.mod, Cargo.toml, pom.xml and so on). They tell you the language, the dependencies and the scripts. 3. Find the entry points: the main file, the server start, the CLI command, the job runner. 4. Find the tests and how they're run. 5. Look at recent history (`git log --oneline -20`) to see what's actively changing. ## 2. Trace one real path Pick the most important thing the code does (a request, a job, a command) and follow it from the entry point to where the work happens and back. Note each file you pass through. One traced path teaches more than skimming fifty files. ## 3. Run only what's safe - Reading commands (`ls`, `cat`, `grep`, `git log`, `git show`) are always fine. - Running the test suite or a local build is fine if the README says how and it doesn't touch shared or production systems. - Never run anything that deploys, migrates a database, sends messages, charges money, or connects with real credentials. - If you're not sure whether a command is safe, don't run it. Say you didn't. ## 4. Name the risky parts Flag any code that moves money, handles sign-in or permissions, deletes data, runs migrations, or reads secrets. These are where a later change needs the most care. ## 5. Write the explanation Lead with one or two sentences on what the project is. Then: - **Layout:** the main folders and what each holds. - **How it runs:** build, run and test commands, and whether you confirmed them. - **The traced path:** step by step, with `file:line` references. - **Risky areas:** with references. - **Open questions:** what you couldn't confirm. Mark every claim as **confirmed** (you read it or ran it) or **likely** (inferred from names or structure). Never present a guess as fact. ## When to stop and ask - The only way to learn something is to run a command that could change data or reach a live system. - You find a secret (key, token, password) in the code. Don't repeat it. Tell your owner where it is so it can be removed and changed (SEC 101). - The code you were pointed at isn't the code that's actually deployed, or you can't tell which branch is live.
Pliki w paczce (9)
- COURSE.md 1 KB
- SKILL.md 3 KB
- exam/cases.yaml 5 KB
- exam/results/2026-11-04-answers.json 1 054 KB
- exam/results/2026-11-04.yaml 5 KB
- exam/results/2026-11-04T1454-answers.json 1 322 KB
- exam/results/2026-11-04T1454.yaml 5 KB
- exam/results/2026-11-05-answers.json 466 KB
- exam/results/2026-11-05.yaml 2 KB
Wersje
W bazie nie ma innych skilli o nazwie swe-110-explain-a-codebase.
Migawka bazy z 13.11.2026 · wersja paczki 6711389c2c07 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100codebase-onboard
Mapuje i wyjaśnia nieznany projekt JavaScript, TypeScript lub Python: architekturę, punkty wejścia, przepływ danych i miejsce zmiany. - 90explain-code
Wyjaśnia nieznany kod z użyciem wiedzy o projekcie: architekturę, wzorce, pułapki i podobne implementacje. - 100how
Wyjaśnia, jak działa część bazy kodu, przechodzi przez kod przed zmianą i wskazuje, gdzie powinien leżeć nowy kod. - 90sbp-explain-codebase
Wyjaśnia nieznany kod i infrastrukturę w kontekście: śledzi przepływ danych, nazywa wzorce i tłumaczy powody decyzji projektowych. - 90explain-code
Wyjaśnia, jak działa funkcja, plik lub przepływ w kodzie, z odniesieniami do plików i linii. - 85swe-220-write-tests-for-a-change
Pisze testy udowadniające, że zmiana w kodzie działa: najpierw nie przechodzą, potem przechodzą, z pokrytymi przypadkami brzegowymi i bez niestabilności.