reactjs / reactjs/react.dev

Variable naming inconsistency in the tutorial documentation

オープン 初心者向け
#4,823 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
JavaScript
スター
11.8k
フォーク
7.9k
平均マージ
1日 11時間
マージ済み PR(30日)
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

content/tutorial/tutorial.md から始め、チュートリアルの render 関数を jumpTo と併せて読み、変数名の一貫性の欠如を確認します。リンクされた CodePen も要求されたドキュメント変更の対象かどうかを確認します。チュートリアルで一貫した名前が使われ、該当する例が初心者にも理解しやすい状態になれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript, react
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
72/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。