Ptt-official-app/Ptt-backend

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

クローズ

#109 opened on 2021/03/02

GitHub で見るコントリビューターガイド
 (6 件のコメント) (0 件のリアクション) (1 人の担当者)Go (65 件のフォーク)auto 404
help wanted

Repository metrics

Stars
 (211 個のスター)
PR merge metrics
 (平均マージ 11m) (30d で 9 merged PRs)

説明

實作細節 / 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

コントリビューターガイド

調査方針
問題にリストされている既存のコードファイル（route classes.go、route classes test.go、route classes mock test.go、route boards articles.go、route boards articles test.go）を確認し、以前にコメントが追加されたファイル（例：route users.go）のパターンに従って、関数とテストにコメントを追加してください。コメントは各関数の目的、パラメータ、戻り値を説明するものにしてください。
技術スタック
go
領域
backend
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Go
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85