-
-
Notifications
You must be signed in to change notification settings - Fork 13
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
Atualiza arquivos básicos de documentação #45
Conversation
O básico da padronização dos repositórios foi atendido aqui. Itens de melhoria (que poderiam ser incluídos na revisão ou deixados em issues para incremento) são:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comentários feitos no review do PR okfn-brasil/querido-diario#605 também são válidos aqui
PR atualizado com as alterações, inclusive vindas de okfn-brasil/querido-diario#605 No contributing.md, deixei um espaço na seção de desafios para inserir texto sobre onde o repositório quer chegar. Este texto poderia ser adicionado na revisão, ou a linha do título deletada se não for necessário no momento |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No geral tá bem legal! Só adicionei dois commits pra corrigir o caminho do README no setup.py
(que iria atualizar a documentação no PyPI) e subi a versão do projeto.
Algumas coisas precisam ser alteradas ainda:
57ee4f5
to
167db7c
Compare
9a84476
to
80a2847
Compare
já aceitei as sugestões e corrigi a história do PR para enxugar os commits @giuliocc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Buscando se adequar ao padrão de documentação adotado no projeto (#okfn-brasil/querido-diario-comunidade#14), este PR:
Adiciona CODE_OF_CONDUCT.md e sua tradução em inglês.
Adiciona FUNDING.yml
Adiciona SUPPORT.md e sua tradução em inglês
Atualiza LICENSE.md
Padroniza layout do README.md e do CONTRIBUTING.md e atualiza seus conteúdos. Apenas renomeia e move para /.github suas versões em inglês, mas não as altera (uma vez que a em português seja aprovada, issues para atualizar a tradução serão abertas)