Merge pull request #2768 from jekyll/remove-docs
This commit is contained in:
Parker Moore
commit
11f629b00e
|
|
@ -1,93 +0,0 @@
|
||||||
コントリビュート
|
|
||||||
==========
|
|
||||||
|
|
||||||
あなたは Jekyll に投じるすばらしいアイディアを持っています。
|
|
||||||
すばらしいことです！次の事柄を心に留めてください。
|
|
||||||
|
|
||||||
* **テストなしではコントリビュートはできません。**
|
|
||||||
* もし、既存の機能への小さな修正やパッチを作成したなら、シンプルなテストを行います。
|
|
||||||
現在のテストスイートの範囲にとどまり、そして
|
|
||||||
[Shoulda](https://github.com/thoughtbot/shoulda/tree/master) や
|
|
||||||
[RR](https://github.com/btakita/rr/tree/master) を使用してください。
|
|
||||||
* もし、それが新しい機能の場合は、必ず新しい
|
|
||||||
[Cucumber](https://github.com/cucumber/cucumber/) の機能を作成し、
|
|
||||||
必要に応じて手順を再利用します。
|
|
||||||
また、あなたがフォークした `site` に
|
|
||||||
急ぎいくつかのドキュメントを用意し、一度マージを行い
|
|
||||||
メイン `site` の jekyllrb.com に転送していただければ幸いです。
|
|
||||||
* あなたのコントリビュートによって Jekyll の振る舞いが変わった場合、ドキュメントを更新すべきです。
|
|
||||||
それは `site/docs` にあります。
|
|
||||||
もし、 docs に情報の誤りがあった場合、遠慮なく追加してください。
|
|
||||||
すばらしいドキュメントはすばらしいプロジェクトを作ります！
|
|
||||||
* Ruby のコードを変更するときは、 [GitHub Ruby Styleguide](https://github.com/styleguide/ruby)
|
|
||||||
に従ってください。
|
|
||||||
* **小さなプルリクエスト** に最善を尽くしてください。
|
|
||||||
簡単に提案された変更はレビューされ、マージされる可能性が高いです。
|
|
||||||
* プルリクエストを送信するとき、プルリクエストのボディを賢明に使用してください。
|
|
||||||
変更されたかどうかの記述、変更の背後にある動機、 [完了したかどうかのタスクリスト](http://git.io/gfm-tasks)
|
|
||||||
もレビュー時間を早めます。
|
|
||||||
|
|
||||||
テストの依存関係
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
テストスイートの実行や gem のビルドのために、
|
|
||||||
Jekyll の依存ツールをインストールする必要があります。
|
|
||||||
Jekyll は Bundler を使用しており、 `bundle` コマンドを実行すると全ての設定が迅速に行われます！
|
|
||||||
|
|
||||||
$ bundle
|
|
||||||
|
|
||||||
はじめる前に、テストを実行し、必ずテストが通ることを
|
|
||||||
確認してください(あなたの環境が適切に設定されているかを確認するために):
|
|
||||||
|
|
||||||
$ bundle exec rake test
|
|
||||||
$ bundle exec rake features
|
|
||||||
|
|
||||||
ワークフロー
|
|
||||||
--------
|
|
||||||
|
|
||||||
これは、あなたの作業がプロジェクトにマージされるもっとも直接的な方法です:
|
|
||||||
|
|
||||||
* プロジェクトをフォークします。
|
|
||||||
* あなたのフォークプロジェクトをクローンします ( `git clone git@github.com:<username>/jekyll.git` )。
|
|
||||||
* トピックブランチを作成し、あなたの変更を含んでください ( `git checkout -b my_awesome_feature` )。
|
|
||||||
* ハックし、テストを追加します。必ずしもこの順番でなくてかまいません
|
|
||||||
* `rake` を実行し、テストが必ず全て通ることを確認してください
|
|
||||||
* 必要に応じて、エラーがないようにコミットを論理的な塊にリベースしてください
|
|
||||||
* ブランチをプッシュしてください ( `git push origin my_awesome_feature` ).
|
|
||||||
* jekyll/jekyll プロジェクトの master ブランチに対してプルリクエストを作成し、
|
|
||||||
あなたの変更内容と、なぜそれをマージすべきかを記述してください
|
|
||||||
|
|
||||||
ドキュメントの更新
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
私たちは Jekyll のドキュメントについて最善を尽くしたいです。
|
|
||||||
私たちはドキュメントをオープンソース化しました、そして
|
|
||||||
あなたが Jekyll に欠けているものを見つけた場合、私たちはプルリクエストを歓迎しています。
|
|
||||||
|
|
||||||
あなたは、 GitHub.com 上の Jekyll リポジトリの [site]({{ site.repository }}/tree/master/site) で
|
|
||||||
jekyllrb.comのドキュメントを見つけることができます。
|
|
||||||
|
|
||||||
全てのドキュメントのプルリクエストは `master` に向けられる必要があります。
|
|
||||||
他のブランチに向けたプルリクエストは受け入れられません。
|
|
||||||
|
|
||||||
GitHub の [Jekyll wiki](https://github.com/jekyll/jekyll/wiki) は、
|
|
||||||
自由に更新することができるように、プルリクエストなしで
|
|
||||||
全ての GitHub ユーザがアクセス権を持つことができます。
|
|
||||||
|
|
||||||
落とし穴
|
|
||||||
-------
|
|
||||||
|
|
||||||
* もし、 gem のバージョンがかちあった場合、コミットを分けてください。
|
|
||||||
この方法だと、メンテナが gem をリリースするときに制御できます。
|
|
||||||
* jekyll/jekyll の最新コミットに基づいて(複数の)パッチを維持してください。
|
|
||||||
それは適用するためのあなたの仕事で、メンテナがしなければならないことを少なくするのは
|
|
||||||
とてもよいことです。
|
|
||||||
* あなたの GitHub issue で [fix], [feature] などのタグをつけないでください。
|
|
||||||
メンテナは積極的に issue を読み、彼らが問題に出くわしたらラベルをつけるでしょう。
|
|
||||||
|
|
||||||
最後に…
|
|
||||||
----------
|
|
||||||
|
|
||||||
ありがとう！ Jekyll のハックは楽しいものでなければなりません。
|
|
||||||
もし、あなたがこのハードを理解するための何かを発見した場合、知らせてください。
|
|
||||||
我々のプロセスやドキュメントを改善することができます！
|
|
||||||
|
|
@ -1,68 +0,0 @@
|
||||||
# [Jekyll](http://jekyllrb.com/)
|
|
||||||
|
|
||||||
[](http://badge.fury.io/rb/jekyll)
|
|
||||||
|
|
||||||
[](https://travis-ci.org/jekyll/jekyll)
|
|
||||||
[](https://codeclimate.com/github/jekyll/jekyll)
|
|
||||||
[](https://gemnasium.com/jekyll/jekyll)
|
|
||||||
|
|
||||||
Tom Preston-Werner, Nick Quaranto や多くの[素晴らしいコントリビュータ](https://github.com/jekyll/jekyll/graphs/contributors)によって作成されています！
|
|
||||||
|
|
||||||
Jekyll は個人プロジェクトや組織のサイトに最適な、シンプルで、ブログを意識した静的サイトジェネレータです。
|
|
||||||
複雑さを排除したファイルベースのCMSのようなものと考えてください。
|
|
||||||
Jekyll はコンテンツを受け取り、 Markdown や Liquid テンプレート をレンダリングし、
|
|
||||||
Apache や Nginx やその他の Web サーバに提供する準備ができた静的な Web サイトを完全に出力してくれます。
|
|
||||||
Jekyll は [GitHub Pages](http://pages.github.com) の背後にあるエンジンなので、
|
|
||||||
あなたの GitHub リポジトリからサイトをホストするために使用する事ができます。
|
|
||||||
|
|
||||||
## 原理
|
|
||||||
|
|
||||||
Jekyll あなたがするように伝えたことをします ― それ以上でもそれ以下でもありません。
|
|
||||||
それは、大胆な仮定によってユーザの裏をかこうとせず、
|
|
||||||
また、不必要な複雑さや設定をユーザに負担しません。
|
|
||||||
簡単に言えば、 Jekyll はあなたの道を開け、
|
|
||||||
真に重要なもの: コンテンツに集中することができます。
|
|
||||||
|
|
||||||
## 開始方法
|
|
||||||
|
|
||||||
* gem を[インストール](http://jekyllrb.com/docs/installation/)します
|
|
||||||
* [使用方法](http://jekyllrb.com/docs/usage/) と [設定方法](http://jekyllrb.com/docs/configuration/) を読みます
|
|
||||||
* 既存の [Jekyll で作られたサイト](https://wiki.github.com/jekyll/jekyll/sites) をチラッと見ます
|
|
||||||
* Fork し、あなたの変更を [コントリビュート](http://jekyllrb.com/docs/contributing/) します
|
|
||||||
* 質問があったら？ irc.freenode.net の `#jekyll` チャンネルをチェックしてください
|
|
||||||
|
|
||||||
## より深く
|
|
||||||
|
|
||||||
* 以前のシステムからの[移行](http://jekyllrb.com/docs/migrations/)
|
|
||||||
* [YAML Front Matter](http://jekyllrb.com/docs/frontmatter/) がどのように働くかを学ぶ
|
|
||||||
* [変数](http://jekyllrb.com/docs/variables/)を使ってサイトに情報を表示する
|
|
||||||
* posts が生成される時の[パーマリンク](http://jekyllrb.com/docs/permalinks/)をカスタマイズ
|
|
||||||
* 人生を容易にするために、組み込みの [Liquid 拡張](http://jekyllrb.com/docs/templates/)を使用する
|
|
||||||
* あなたのサイト固有のコンテンツを生成するために、カスタム[プラグイン](http://jekyllrb.com/docs/plugins/)を使用する
|
|
||||||
|
|
||||||
## 実行時の依存関係
|
|
||||||
|
|
||||||
* Commander: コマンドラインインターフェース構築 (Ruby)
|
|
||||||
* Colorator: コマンドライン出力に色付け (Ruby)
|
|
||||||
* Classifier: posts の関連を生成 (Ruby)
|
|
||||||
* Directory Watcher: サイトの自動再生成 (Ruby)
|
|
||||||
* Kramdown: デフォルトの Markdown エンジン (Ruby)
|
|
||||||
* Liquid: テンプレートシステム (Ruby)
|
|
||||||
* Pygments.rb: シンタックスハイライト (Ruby/Python)
|
|
||||||
* RedCarpet: Markdown エンジン (Ruby)
|
|
||||||
* Safe YAML: セキュリティのために構築された YAML パーサ (Ruby)
|
|
||||||
|
|
||||||
## 開発時の依存関係
|
|
||||||
|
|
||||||
* Launchy: クロスプラットフォーム ファイルランチャ (Ruby)
|
|
||||||
* Maruku: Markdown スーパーセット インタプリタ (Ruby)
|
|
||||||
* RDiscount: Discount Markdown プロセッサ (Ruby)
|
|
||||||
* RedCloth: Textile サポート (Ruby)
|
|
||||||
* RedGreen: よりよいテスト出力 (Ruby)
|
|
||||||
* RR: モック (Ruby)
|
|
||||||
* Shoulda: テストフレームワーク (Ruby)
|
|
||||||
* SimpleCov: カバレッジフレームワーク (Ruby)
|
|
||||||
|
|
||||||
## ライセンス
|
|
||||||
|
|
||||||
[ライセンス](https://github.com/jekyll/jekyll/blob/master/LICENSE)を見てください。
|
|
||||||
Loading…
Reference in New Issue