Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Plibonigo] Dokumenti la fontkodon. #151

Open
CourteousCoder opened this issue Jan 10, 2019 · 1 comment
Open

[Plibonigo] Dokumenti la fontkodon. #151

CourteousCoder opened this issue Jan 10, 2019 · 1 comment
Assignees
@CourteousCoder
Labels
facila

Comments

@CourteousCoder
Copy link
Contributor

Kialo

Tasko por dokumenti la deponejon, funkciojn, klasojn, ktp ofte estas bona una tasko por novaj kontribuantoj pro du ĉefaj kialoj:

  1. Ĉar ĝi donos al ili oportunon ekkoni la fontkodon.
  2. Ĉar ĝi helpos ĉiuj kontribuantoj havi pli da bona dokumentado en la projekto.

Tipoj de Dokumentado:

  1. Projekt(er)-nivela per README.md dosieroj
  2. Klas-nivela kaj funkci-nivela per Pitonaj DOCSTRING-aj komentoj.
  3. 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.
@CourteousCoder
Copy link
Contributor Author

Mi volontas fari ĉi-tiun taskon.

@bwildenhain bwildenhain mentioned this issue Feb 5, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CourteousCoder CourteousCoder

Labels
facila
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@interDist @CourteousCoder