Switch branches/tags
Clone or download

README.md

リファレンスページ はこちら

このプロジェクトについて

  • rpgtkoolmv/corescript で開発されている、RPGツクールMVのコアスクリプトのリファレンスを作る非公式プロジェクトです。
  • コアスクリプトをJSDocによりドキュメント生成したものをMarkdownに変換したドキュメントを元に編集を行っていきます。

編集について

コントリビューターを募集中

  • このプロジェクトは始まったばかりです!ぜひ皆さんもご協力お願いします。

編集の基本方針

  • docs/jsdoc/ を直接書き換える。
  • 相談が必要な内容の変更はブランチを分けて行い、切りのよいところでPullRequestを提出
    • PullRequest が問題なければ、 masterブランチにマージを行う

編集上の注意

  • GitHub-Pages上のリファレンスページに対応するようにリンクの連携を行ってください。
  • GitHub-Pagesでの反映には数分~数十分時間がかかることがあります。
  • 編集後・マージ後は必ずコミットログを確認してください。✔️のときは成功、🌕は検証中、のときは失敗です。失敗を直さないとずっと自動更新が止まり続ける可能性があります。
  • 絶対にgit reset --hardしないでください。

編集する上で望ましいこと

基本

  • ジャイアントコミット(大きな変更を一気に行う)を避ける
  • 相談事や不具合報告はすべてIssuesにスレ立てする
  • 編集後、必ずコミットログと反映後のリファレンスページを確認して、問題がないことを確認する

上級

  • 大きな変更や一括変更を行う場合、ローカルに落として作業してブランチを分けてからプルリクを投げる。
  • ブランチ名はfeature/YYYYMMDD-this-is-branch-nameに従う

編集手順

通常の変更

  1. GitHubアカウントを作る
  2. docs/jsdoc/ から編集するファイルを選ぶ
  3. 右上にある鉛筆マークをクリック
  4. エディタが開くので、編集作業を行う
  5. 編集が終わったら一番下にあるCommit changesを入力する
  • 上から1つ目の小さい入力欄は編集内容を1行で表し入力する
  • 上から2つ目の入力欄は編集内容を詳しく説明し入力する(省略可)
  • チェックボックスはCommit directly to the master branchを選ぶ
  1. Commit changesを押して決定

相談が必要な内容の場合

  1. GitHubアカウントを作る
  2. docs/jsdoc/ から編集するファイルを選ぶ
  3. 右上にある鉛筆マークをクリック
  4. エディタが開くので、編集作業を行う
  5. 編集が終わったら一番下にあるCommit changesを入力する
  • 上から1つ目の小さい入力欄は編集内容を1行で表し入力する
  • 上から2つ目の入力欄は編集内容を詳しく説明し入力する(省略可)
  • チェックボックスはCreate a new branch for this commit and start a pull request.を選ぶ
  1. Will be created asの横にある入力欄はデフォルトのままでOK
  • できれば、feature/20181104-update-XXXXのようにわかりやすいネーミングにするとより良い
  1. Propose file changeを押して決定
  2. プルリクエスト登録画面が開くので、タイトルの入力欄に相談内容のタイトル、大きな入力欄に相談内容の詳細を入力
  3. Create pull requestをクリック
  4. 管理者がマージするのを待つ

(上級者向け)ファイルを一括で編集を行う場合

  1. GitHubアカウントを作り、Gitをインストール
  2. コマンドプロンプトで git clone https://github.com/katai5plate/RPGMV-CoreScript-Reference.git
  3. コマンドプロンプトのカレントディレクトリにファイルがダウンロードされるので、そこで直接ファイルを編集する
  4. 編集を行う内容でブランチを作成する。RPGMV-CoreScript-Referenceディレクトリをカレントディレクトリにして、コマンドプロンプトからgit checkout -b "feature/YYYYMMDD-ブランチ名"を入力。YYYYMMDDは2018/11/04なら20181104というように書く。ブランチ名は英数とハイフン区切りで編集内容を短く書く。例:feature/20181104-update-XXXX-pages
  5. 編集を開始し、一段落終わったらちょくちょくコミット作業を行う
  • RPGMV-CoreScript-Referenceディレクトリをカレントディレクトリにして、コマンドプロンプトからgit add -Aを入力。すると変更がターゲティングされる。
  • つぎにgit commit -m "コミット内容"を入力。コミット内容にここまでの変更内容を簡単に書く。
  1. 作業中のブランチでの編集を終わらせたら、コミット作業を終えて、RPGMV-CoreScript-Referenceディレクトリをカレントディレクトリにしたコマンドプロンプトからgit push origin ブランチ名を入力。ブランチ名は3.で入力したものと同じ。例:git push origin feature/20181104-update-XXXX-pages
  2. 成功したらここにアクセス
  3. base:masterになっていることを確認し、compare:から自分のブランチを選ぶ。
  4. プルリクエスト登録画面が開くので、タイトルの入力欄に相談内容のタイトル、大きな入力欄に相談内容の詳細を入力
  5. Create pull requestをクリック
  6. 管理者がマージするのを待つ

JSDoc作成を行う場合

開く

  • コアスクリプトの大幅変更などにより、内容の大量変更が必要になった際に行う。

必要環境

1. Node.js をインストール

node -v
npm -v

2. Git をインストール

https://eng-entrance.com/git-install

  • コマンドプロンプトで以下を入力してエラーがなければ成功
git --version

3. yarn をインストール

https://yarnpkg.com/lang/ja/docs/install/#windows-stable

  • コマンドプロンプトで以下を入力してエラーがなければ成功
yarn -v

4. gulp をインストール

Node.js を正常にインストールした上で、コマンドプロンプトで以下を入力すればOK

npm install gulp-cli -g
  • コマンドプロンプトで以下を入力してエラーがなければ成功
gulp -v

手順

  1. git clone https://github.com/katai5plate/RPGMV-CoreScript-Reference.git
  2. cd RPGMV-CoreScript-Reference && yarn install
  3. ./srcフォルダを作り、そこにjsファイルを置く
  4. yarn build