learnbyexample / learnbyexample/ThinkRubyBuild

Contributing

Ouverte
#1 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
TeX
Étoiles
32
Forks
2
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Lisez les consignes de contribution, puis examinez les fichiers de chapitres sous chapters_md et les sources des illustrations sous book/figs. Les contributions doivent respecter les règles indiquées concernant Markdown et la terminologie, et les modifications de chapitres ou les exercices non traduits doivent être signalés dans le gestionnaire d’issues ; aucune modification précise de la documentation n’est identifiée ici.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
latex, markdown, ruby
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.