Ptt-official-app/Ptt-backend

[主線] [PTT] 增加基本註解

Chiusa

#109 aperta il 2 mar 2021

Vedi su GitHubGuida contributor
 (6 commenti) (0 reazioni) (1 assegnatario)Go (65 fork)auto 404
help wanted

Metriche repository

Star
 (211 stelle)
Metriche merge PR
 (Merge medio 11m) (9 PR mergiate in 30 g)

Descrizione

實作細節 / Details of Implement

現有大部分的 code 皆未有註解，須對 function 跟 test 增加註解

期程 / Schedule

  • 討論時間： 一天
  • 實作時間： 一天
  • 確認時間： 一天

相關文件 / Documents

實作中

相關項目 / Child Task

  • route_users.go , route_users_test.go , route_users_mock_test.go #110
  • route_token.go , route_token_test.go , route_token_mock_test.go #173
  • route_classes.go , route_classes_test.go , route_classes_mock_test.go #174
  • route_boards.go, route_boards_test.go , route_boards_mock_test.go #175
  • route_boards_articles.go , route_boards_articles_test.go #176

Guida contributor

Direzione di ricerca
Esamina i file di codice esistenti elencati nel problema (route classes.go, route classes test.go, route classes mock test.go, route boards articles.go, route boards articles test.go) e aggiungi commenti alle funzioni e ai test seguendo il modello dei file precedentemente commentati (es. route users.go). Assicurati che i commenti spieghino lo scopo di ogni funzione, i parametri e i valori di ritorno.
Tech stack
go
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85