reflux/refluxjs

Can we have an API reference?

Open

#291 建立於 2015年3月14日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)JavaScript (5,377 star) (354 fork)batch import
enhancementhelp wanted

描述

As well as the general readme, I think reflux should have an API.md file that would list the properties of the definition objects that you pass into createStore, createAction etc. as well as their methods.

At the moment, even Store#getInitialState isn't even mentioned in the readme, which is very confusing. I would be happy to make a PR, but I'm sure someone with a better knowledge of the codebase would make a better API reference.

貢獻者指南

技術棧
javascriptreact
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic JavaScriptfamiliarity with Reflux APIdocumentation writing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Begin by exploring the source code, especially files like `src/createStore.js`, `src/createAction.js`, and any others that expose public API. Note all methods and properties. Then create an `API.md` file that documents these, referencing the existing README for style. Ensure to include `Store#getInitialState` as mentioned in the issue. No PRs are linked, so this is a fresh documentation task.