Skip to content

Commit 7bd5b3a

Browse files
authored
Adicionando padrão para README no Contributing.md (brazilian-utils#401)
1 parent ae780c5 commit 7bd5b3a

File tree

1 file changed

+67
-5
lines changed

1 file changed

+67
-5
lines changed

CONTRIBUTING.md

Lines changed: 67 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -265,14 +265,76 @@ Type "help", "copyright", "credits" or "license" for more information.
265265

266266
### 10. Atualizar READMEs
267267

268-
Atualize os arquivos `brutils-python/README.md` e `brutils-python/README_EN.md` com as suas alterações.
268+
Atualize os arquivos `brutils-python/README.md` e `brutils-python/README_EN.md` com suas alterações.
269269

270-
Esses arquivos são fundamentais para a documentação da biblioteca, garantindo que os usuários saibam como utilizar corretamente os recursos oferecidos. Por isso, é essencial que eles estejam sempre atualizados.
270+
Esses arquivos são essenciais para a documentação da biblioteca, ajudando os usuários a entender como utilizar os recursos oferecidos. Portanto, é importante mantê-los sempre atualizados.
271271

272-
- O arquivo brutils-python/README.md contém a documentação em Português.
273-
- O arquivo brutils-python/README_EN.md contém a documentação em Inglês.
272+
- O arquivo brutils-python/README_EN.md contém a documentação em Inglês, e pode usar o conteúdo já descrito na docstring diretamente.
273+
- O arquivo brutils-python/README.md contém a documentação em Português. Para este, basta traduzir a docstring da função.
274274

275-
Se precisar de ajuda para traduzir, você pode utilizar ferramentas como o Google Tradutor ou ChatGPT. Não se preocupe com possíveis erros na tradução, pois sugeriremos ajustes quando necessário.
275+
Se precisar de assistência na tradução para o Português, ferramentas como Google Tradutor ou ChatGPT podem ajudar. Não se preocupe com possíveis erros de tradução, pois sugeriremos ajustes quando necessário.
276+
277+
Exemplo em Inglês (README_EN.md):
278+
279+
````md
280+
### format_cep
281+
282+
This function takes a CEP (Postal Code) as input and, if it is a valid
283+
8-digit CEP, formats it into the standard "12345-678" format.
284+
285+
Args:
286+
287+
- cep (str): The input CEP (Postal Code) to be formatted.
288+
289+
Returns:
290+
291+
- str: The formatted CEP in the "12345-678" format if it's valid,
292+
None if it's not valid.
293+
294+
Example:
295+
296+
```python
297+
>>> from brutils import format_cep
298+
>>> format_cep('01310200')
299+
'01310-200'
300+
>>> format_cep("12345678")
301+
"12345-678"
302+
>>> format_cep("12345")
303+
None
304+
```
305+
````
306+
307+
Exemplo em Português (README.md):
308+
309+
````md
310+
### format_cep
311+
312+
Formata um CEP (Código de Endereçamento Postal) brasileiro em um formato padrão.
313+
Esta função recebe um CEP como entrada e, se for um CEP válido com 8 dígitos,
314+
o formata no padrão "12345-678".
315+
316+
Argumentos:
317+
318+
- cep (str): O CEP (Código de Endereçamento Postal) de entrada a ser
319+
formatado.
320+
321+
Retorna:
322+
323+
- str: O CEP formatado no formato "12345-678" se for válido, None se não for
324+
válido.
325+
326+
Example:
327+
328+
```python
329+
>>> from brutils import format_cep
330+
>>> format_cep('01310200')
331+
'01310-200'
332+
>>> format_cep("12345678")
333+
"12345-678"
334+
>>> format_cep("12345")
335+
None
336+
```
337+
````
276338

277339
### 11. Faça o Commit e Envie as Suas Alterações
278340

0 commit comments

Comments
 (0)