Kultaiset säännöt (Standards)¶
Tämä dokumentti määrittelee RepoDock-ekosysteemin standardit, joita automaatiomoottori valvoo. Sääntöjen noudattaminen on edellytys projektin näkyvyydelle ja sen etenemiselle elinkaaressa kohti tuotantotilaa.
1. Nimeämisstandardit¶
Repositorioiden nimeäminen ohjaa automaattista taksonomiaa. Nimen on noudatettava muotoa: [teema]-[projektin-nimi].
| Teema-etuliite | Käyttötarkoitus | Esimerkki |
|---|---|---|
study- | Teoreettinen oppiminen ja muistiinpanot. | study-neural-networks |
lab- | Tekniset kokeilut ja prototyypit. | lab-rust-api-bench |
project- | Ratkaisut ja sovelluskehitys. | project-customer-portal |
tool- | Sisäiset apuvälineet ja skriptit. | tool-log-cleaner |
infra- | Infrastruktuuri ja IaC (Terraform, Ansible). | infra-aws-base |
engine- | Ydinmoottorit ja kirjastot. | engine-data-parser |
2. Dokumentaation minimivaatimukset¶
Jokaisen repositorion on sisällettävä seuraavat rakenteelliset elementit, jotta se läpäisee automaattisen indeksoinnin:
- README.md: Juuressa sijaitseva tiedosto, joka sisältää projektin kuvauksen.
- Metadata-lohko: README:n alkuun sijoitettu tekninen tunniste (YAML tai JSON).
- Lisenssi: Selkeä määrittely käyttöoikeuksista.
3. Laatuportit ja Definition of Done (DoD)¶
Automaatiomoottori laskee projektin Health Score -arvon seuraavien kriteerien perusteella:
graph TD
A[Koodimuutos] --> B{Automaattinen skannaus}
B -- Läpäisee --> C[Linting & Tyyliopas]
B -- Läpäisee --> D[Tietoturvatarkistus]
B -- Läpäisee --> E[Testikattavuus > 80%]
C & D & E --> F{Health Score: Vihreä}
F --> G[Päivitys portaaliin] ` Dokumentin tila: Luonnos — Pvm: 10.01.2026