Skip to content

Latest commit

 

History

History
179 lines (125 loc) · 5.81 KB

CONTRIBUTING.md

File metadata and controls

179 lines (125 loc) · 5.81 KB

Contribution Guide

このリポジトリへのコントリビュート方法についてガイドです。

ドキュメントの記述

ハンズオン用の資料は公開時にVuePressでコンパイルされます。 基本的にMarkdownで記述されていますが、一部VuePress独自の記法が使われています。VuePressの記法についてはドキュメントをご覧ください。

Issues

次のIssueを受け付けています。

  • 資料に関する質問
  • 内容についての問題や改善点の報告
  • 資料の新規追加などの提案

その他気軽にIssueを切っていただいて構いません。

Pull Request

Pull Requestはいつでも歓迎しています。

受け入れるPull Request

次の種類のPull Requestを受け付けています。 基本的なPull Request（特に細かいもの）は、Issueを立てずにPull Requestを送ってもらって問題ありません。

修正内容や改善方法に疑問がある場合は、Issueを立てて相談してください。

  • 誤字の修正
  • サンプルコードやスペルの修正
  • 別の説明方法の提案や修正
  • 文章をわかりやすくするように改善
  • 資料の新規追加
  • ウェブサイトの改善

📝 Note: Pull Requestを送った内容はこのリポジトリのライセンス（CC BY-SA）が適用されます。

受け入れていないPull Request

修正の送り方

文章の誤字の修正程度なら、直接GitHub上で編集してPull Requestを送ってください。

ローカルで編集して送りたい場合は次の手順を試してください。

  1. Forkする
  2. Branchを作る: git checkout -b my-new-feature
  3. 変更をコミットする: git commit -am 'Add some feature'
  4. Pushする: git push origin my-new-feature
  5. Pull Requestを送る :D

修正の確認方法

この資料はVuePressでコンパイルされています。 make runで開発用サーバーを起動した後、http://localhost:8080/へアクセスすることで、資料のプレビュー表示ができます。

make setup # install vuepress
make run # start dev server

# open http://localhost:8080/

ディレクトリ構造

docs 下にハンズオンの大項目(例: development, server-app, etc...)があり、その下に各ハンズオン用のディレクトリがあります。 各ハンズオンディレクトリには、メインのドキュメントになるREADME.mdとその他画像やサンプルコードなどが含まれます。

└── docs
    └── development
        ├── jenkins
        │   ├── README.md
        │   ├── images
        │   │   └── create-job.png
        │   │
        │   └── codes
        |       └── sample.js
        └── kubernetes
            ├── README.md
            └── images

コミットメッセージ規約

AngularJSのGit Commit Guidelinesをベースとしています。

以下のような形で

  • 1行目に概要
  • 2行目は空行
  • 3行目から本文

最後に関連するIssue(任意)を書きます。

feat(ngInclude): add template url parameter to events

The `src` (i.e. the url of the template to load) is now provided to the
`$includeContentRequested`, `$includeContentLoaded` and `$includeContentError`
events.

Closes #8453
Closes #8454

                         scope        commit title

        commit type       /                /
                \        |                |
                 feat(ngInclude): add template url parameter to events

        body ->  The 'src` (i.e. the url of the template to load) is now provided to the
                 `$includeContentRequested`, `$includeContentLoaded` and `$includeContentError`
                 events.

 referenced  ->  Closes #8453
 issues          Closes #8454

commit type としては次のようなものがあります。

  • feat
    • 新しい機能、章、節の追加など
    • 更新履歴に載るような新しいページを追加
  • fix
    • 意味が変わる修正
    • 更新履歴に載るような修正
  • docs
    • 基本的には使わない
    • README.mdやCONTRIBUTING.mdや本体のプロジェクト全体のドキュメントについて
  • refactor
    • 意味が変わらない修正
    • 更新履歴に載らないような修正
  • style
    • スペースやインデントの調整
    • Lintエラーの修正など
  • perf
    • パフォーマンス改善
  • test
    • テストに関して
  • chore
    • その他
    • typoの修正など

commit typeは、迷ったらとりあえずchoreと書きます。 scopeも省略して問題ないので以下のような形でも問題ありません。

chore: コミットメッセージ

書き方の色々

書き方に関するルールや表記統一について

コードの参照方法

事前に説明した特定のコードを参照したい場合は、サンプルコードのファイル名を参照に利用してください。

[import, example.js](src/example.js)

色々文章...

[example.js](#example.js)では、 ....