Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adicionar o arquivo CONTRIBUTING.md e jupytext #3

Merged
merged 6 commits into from Oct 13, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 42 additions & 0 deletions workshops/pythonbrasil2021/CONTRIBUTING.md
@@ -0,0 +1,42 @@
# Bem-vindas ao guia de contribuição do `Tutorial de lis.py - Python Brasil 2021` <!-- omit in toc -->

Obrigado por dedicar seu tempo em contribuir para nosso projeto! :sparkles:.

Leia nosso [Código de Conduta](https://python.org.br/cdc/) para manter nossa comunidade acessível e respeitável.


## Antes de começar

- Esse material é uma versão traduzida do workshop/tutorial de [lis.py](https://github.com/fluentpython/lispy/tree/main/workshops/thoughtworks2021) para Português do Brasil.
- Para facilitar a visualização das mudanças realizadas nos notebooks (arquivos `.ipynb`) nós estamos utilizando a ferramenta [`jupytext`](https://github.com/mwouts/jupytext).
- Todas as referencias utilizadas para a contrução desse material estão no `README.md`.
- Estamos usando o Python 3.7 ([link](https://www.python.org/downloads/release/python-379/)) para manter a compatibilidade com a versão do `Binder`.


## Reportando bugs/typos e sugerindo melhorias

Você é mais que bem-vinda a sugerir melhorias ao tutorial. Pedimos apenas que tente incluir o máximo de detalhes possíveis e que verifique se nenhuma issue ou pull request já foi criado por outra pessoa com a mesma sugestão.

Caso seja algo novo, sinta-se livre para criar uma nova issue.

O mesmo vale para typos (erros ortograficos).

## Criando pull requests

Você decidiu contribuir para o projeto! Yay!

Faça um fork do projeto e crie uma nova branch. Mais detalhes [aqui](https://docs.github.com/pt/enterprise/2.17/user/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).

Aqui algumas dicas:

* Caso decida trabalhar em alguma _issue_, comente na _issue_ escolhida. Dessa forma,
outras pessoas saberão que tem alguém trabalhando nela. Caso tenha ficado perdido ou com
dúvidas, peça ajuda.

* Instale o as dependencias que estão no `requirements.txt`.

* Quando finalizar suas modificações no notebook (arquivo `.ipynb`), execute o comando `jupytext --to py <NOME DO ARQUIVO NOTEBOOK>.`


Sentiu falta de algo nesse guia? Conta pra gente!