learnbyexample / learnbyexample/ThinkRubyBuild

Contributing

Abierto
#1 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
TeX
Estrellas
32
Forks
2
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Lee las directrices de contribución y, después, inspecciona los archivos de los capítulos en chapters_md y las fuentes de las ilustraciones en book/figs. Las contribuciones deben seguir las reglas de Markdown y terminología indicadas, y las modificaciones de capítulos o los ejercicios no traducidos deben anotarse en el gestor de incidencias; aquí no se identifica ningún cambio específico en la documentación.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
latex, markdown, ruby
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.