CONTRIBUIR.md

Como contribuir

Procedimento

Para contribuir:

1. Use o GitHub para fazer um fork do repositório principal.

2. Clone o seu fork em sua máquina local.

3. Faça commit explicando claramente o motivo de cada alteração.

4. Faça push de suas alterações para o seu fork.

5. Use o GitHub para submeter um pull request do seu fork para o repositório principal, incluindo uma descrição clara das alterações propostas.

Critérios editoriais

Marcação de palavras no texto corrido

Nomes de variáveis, funções e módulos que aparecem nos exemplos antes e depois de um parágrafo devem ser marcadas como código, usando crases, assim: x, factorial, os.path.

Os nomes dos tipos mais comuns, como string, float e bytes, exigem uma decisão. Por exemplo, quando o assunto é cadeia de caracteres qualquer, use string sem adorno, mas quando se está falando especificamente do tipo string, em uma discussão sobre tipos, use marcação de código: string. O motivo desse critério é evitar poluir demais o texto com marcações de código quando se trata genericamente desses conceitos.