reactjs / reactjs/react.dev

Variable naming inconsistency in the tutorial documentation

未關閉 適合新手
#4,823 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
JavaScript
星號
11.8k
分支
7.9k
平均合併
1 天 11 小時
30 天內合併 PR
11

描述

Hi,
I have just used the React tutorial, it is great!
It helps a lot to learn the basic.

While working, I have spotted a small inconsistency on https://github.com/reactjs/reactjs.org/blob/main/content/tutorial/tutorial.md

When creating the buttons to move into the history, we are using a move variable that we are sending to jumpTo:

image

But jumpTo use step to make the moves:

image

I suggest that we switch the move and step variables of the render function to make the tutorial more understandable by beginners:

image

I can push a merge request for the documentation but I do not know how to change the source code linked by @gaearon on codepen:
https://codepen.io/gaearon/pen/gWWZgR?editors=0010

Is there a way to do that?

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從 content/tutorial/tutorial.md 開始,結合 jumpTo 閱讀教學中的 render 函式,以確認變數命名不一致的問題。檢查連結的 CodePen,以確定它是否也屬於所要求的文件變更。完成的標準是教學使用一致的名稱,且相關範例對初學者而言仍然容易理解。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
javascript, react
領域
documentation
Issue 類型
文件
難度
1/5
預估耗時
1 小時以內
活躍度
停滯
描述清晰度
描述清楚
新手友好度
72/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。