learnbyexample / learnbyexample/ThinkRubyBuild
Contributing
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TeX
- Sterne
- 32
- Forks
- 2
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
xfigif you need to change an illustration. You'll need to use.figfiles as input ( https://github.com/learnbyexample/ThinkRubyBuild/tree/master/book/figs) and output format needed ispng
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Lies die Richtlinien für Beiträge und prüfe anschließend die Kapiteldateien unter chapters_md sowie die Illustrationsquellen unter book/figs. Beiträge sollten den angegebenen Markdown- und Terminologieregeln folgen; Kapiteländerungen oder nicht übersetzte Übungen sollten im Issue-Manager vermerkt werden. Hier wird keine konkrete Dokumentationsänderung genannt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- latex, markdown, ruby
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100