Ptt-official-app/Ptt-backend

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

Open

#109 opened on Mar 2, 2021

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Go (65 forks)auto 404
help wanted

Repository metrics

Stars
 (211 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Review the existing code files listed in the issue (route classes.go, route classes test.go, route classes mock test.go, route boards articles.go, route boards articles test.go) and add comments to functions and tests following the pattern from previously commented files (e.g., route users.go). Ensure comments explain the purpose of each function, parameters, and return values.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85