learnbyexample / learnbyexample/ThinkRubyBuild

Contributing

オープン
#1 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

主要言語
TeX
スター
32
フォーク
2
PR マージ指標
30日以内にマージされた PR はありません

説明

By contributing to this project, you are agreeing to do so under these licenses: https://github.com/learnbyexample/ThinkRubyBuild#license

This issue manager will act as a guideline for contributing as well as for clarifying questions about them

  • Reference book: https://greenteapress.com/thinkpython2/html/index.html
  • Use only markdown, no html
    • This restriction is mainly because using html might prevent rendering the book using other tools which accept GitHub style markdown, but not its extensions.
    • This is causing issue to display math equations, worked around in some places using Ruby style expression, using images, etc. If necessary, html will be allowed
  • Chapter/sections can be linked in other parts of the book using anchors. GitHub automatically creates anchors for headers (click icon to the left of headings). For example: https://github.com/learnbyexample/ThinkRubyBuild/blob/master/chapters_md/fruitful_methods.md#boolean-methods - to link this, use [Boolean methods](./fruitful_methods.md#boolean-methods) where filename is needed only when linking from another chapter
  • Terms changed from Python to Ruby:
    • Function --> Method (except when referring to external definitions like mathematical functions)
    • List --> Array
    • Dictionary --> Hash
  • Use issue manager (one issue manager to collate notes per chapter) to note down a few details before submitting a PR
    • mention if any chapter/section name has changed, this will be needed to correct links in other places
    • mention if any exercise cannot be translated - might be referred to in another chapter
    • etc
  • Use xfig if you need to change an illustration. You'll need to use .fig files as input ( https://github.com/learnbyexample/ThinkRubyBuild/tree/master/book/figs) and output format needed is png

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

貢献ガイドを読んだうえで、chapters_md 配下の章ファイルと book/figs 配下のイラストのソースを確認してください。貢献は、指定された Markdown と用語の規則に従う必要があります。また、章の変更や未翻訳の演習は issue マネージャーに記録してください。ここでは、具体的なドキュメントの変更は特定されていません。

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

評価

技術スタック
latex, markdown, ruby
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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