reflux/refluxjs

Can we have an API reference?

Open

#291 opened on 2015年3月14日

GitHub で見る
 (6 comments) (0 reactions) (0 assignees)JavaScript (5,377 stars) (354 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.