pasportaservo
pasportaservo copied to clipboard
[Plibonigo] Dokumenti la fontkodon.
Kialo
Tasko por dokumenti la deponejon, funkciojn, klasojn, ktp ofte estas bona una tasko por novaj kontribuantoj pro du ĉefaj kialoj:
- Ĉar ĝi donos al ili oportunon ekkoni la fontkodon.
- Ĉar ĝi helpos ĉiuj kontribuantoj havi pli da bona dokumentado en la projekto.
Tipoj de Dokumentado:
- Projekt(er)-nivela per README.md dosieroj
- Klas-nivela kaj funkci-nivela per Pitonaj DOCSTRING-aj komentoj.
- Klarigo de koderoj, kiuj jam ne sufiĉe klaras.
Fina rimarko
Klari estas laŭ onia opinio, do oni eble devus skevi la stilon de la deponjeo.
Mi volontas fari ĉi-tiun taskon.