learnbyexample / learnbyexample/ThinkRubyBuild

Contributing

Aberta
#1 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
TeX
Estrelas
32
Forks
2
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Leia as orientações para contribuições e, em seguida, inspecione os arquivos de capítulos em chapters_md e as fontes das ilustrações em book/figs. As contribuições devem seguir as regras de Markdown e terminologia indicadas, e as alterações nos capítulos ou os exercícios não traduzidos devem ser registrados no gerenciador de issues; nenhuma alteração específica na documentação é identificada aqui.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
latex, markdown, ruby
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
Menos de uma hora
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.