turicas/covid19-br

Ajustar documentação da API

開放

#182 建立於 2020年6月29日

在 GitHub 查看貢獻者指南
 (1 則留言) (0 個反應) (0 位負責人)Python (123 個分叉)batch import
documentationgood first issuehelp wanted

倉庫指標

星標
 (532 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

Na documentação da API, a ordem dos campos não reflete a ordem dos campos definidos em schema/*.csv nem datapackage.json.

API doc X CSV Schema

É possível fazer manualmente, mas idealmente seria possível automatizar tomando a o arquivo datapackage.json como referência.

貢獻者指南

研究方向
將每個API文檔端點的字段順序與對應的CSV模式進行比較，並更新API文檔以匹配。對於自動化，考慮使用datapackage.json作為參考。
技術棧
python
領域
backenddocumentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75