Skip to content

Latest commit

 

History

History
98 lines (76 loc) · 4.58 KB

CONTRIBUTING.md

File metadata and controls

98 lines (76 loc) · 4.58 KB

How to contribute このプロジェクトへの関わり方

WordPress のユーザーマニュアルを作っています。どなたでも使っていただけますし、どなたでも作成に参加できます。 フォークしてプルリクエストを送ってください。

WordPress の管理画面(ダッシュボード)の操作方法をメインに、これを読めば WordPress の基本操作は大丈夫というマニュアルを目指しています。

下記の章立てに沿って作成していますが、この内容についても過不足指摘あればプルリクエストもしくはissueをお願いします。

一旦フォークしたリポジトリについて、新たに作業を再開するときは、本体リポジトリの最新の状態をフォークしたリポジトリにも反映してから作業する必要があります。方法についてはコチラをご覧ください。 https://github.com/jawordpressorg/user-manual/wiki

章立て

  1. ログインの方法
  2. 投稿方法
    • 見出しをつける
    • 画像をテンプルする
    • カテゴリーをつける
    • タグを付ける
    • アイキャッチ
    • プレビュー/下書き
    • 投稿日の設定
  3. 固定ページ
    • 投稿方法は投稿を確認
    • 順序
    • ページテンプレート
  4. 外観
    • テーマ
      • 変更
      • 新規追加
    • カスタマイザー
      • カスタムメニュー
      • ウィジェット
  5. プラグイン
    • 有効化
    • 新規追加
  6. ユーザー
    • プロフィール設定
      • パスワード変更
      • メールアドレス変更
      • ニックネーム
    • ユーザの追加
  7. 設定
    • 一般設定
    • 表示設定
  8. 更新
    • アップデート

ライセンス

WordPress ソフトウェアと同じく GPL バージョン 2 またはそれ以降の互換ライセンス

ローカルリポジトリの作り方

Githubアカウントの作成

Github アカウントをお持ちでなければ作成します。

自分のリポジトリへのフォーク

Githubにログイン後、WordPressドキュメントを開き、右上の「Fork」をクリックします。

ローカルへのダウンロード(git clone)

  1. 自分のGithubのフォークしたリポジトリページを開きます。
  2. 「Clone or download」をクリックし、ご自分でご利用の方法に応じ、ローカルにcloneします。

gh-pagesブランチをチェックアウトし、そこからトピックブランチを作成します。

トピックブランチでドキュメントを追加修正後、gh-pagesブランチにマージします。

自分のリポジトリにプッシュします。

プルリクエストを送ります。

テンプレート修正の仕方

以下は、デザインテンプレートを変更したい方向けの情報です。ローカルリポジトリにて Jekyll を利用し、実際の出力内容を確認しながら修正を行います。

使い方

  1. ターミナルで、Gem がなければインストールしておく。gem -v でバージョン番号が出れば対応不要。
  2. おなじく Jekyll がなければインストールしておく。コマンドは gem install jekyll
  3. ローカルリポジトリのある場所まで移動
  4. jekyll serve -w を実行
  5. 出力メッセージ内 Server address: 以下に記載のアドレスにアクセス。たとえば http://127.0.0.1:4000/wordpress-document/
  6. 実際の GitHub ページと同じであることをたしかめて、_layouts ディレクトリ以下のテンプレートを編集します。

時間がないときの編集・確認方法

  1. リポジトリをフォークする
  2. フォークしたリポジトリを表示する
  3. 編集したいファイルの編集ボタン(鉛筆のマーク)をクリックする
  4. 「Preview changes」をクリックすると、プレビューを確認できます。
  5. 「Commit changes」ボタンをクリックして、保存します。
  6. 「Pull requests」をクリックします
  7. 「New pull request」ボタンをクリックします。
  8. 差分を確認して「Create pull request」ボタンをクリックします
  9. フォーク元のリポジトリにプルリクエストを送ります。