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

Atualiza arquivos básicos de documentação #45

Merged
merged 3 commits into from
Aug 3, 2023

Conversation

trevineju
Copy link
Member

@trevineju trevineju commented Aug 26, 2022

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)

@trevineju trevineju marked this pull request as ready for review September 16, 2022 21:28
@trevineju trevineju changed the title Atualiza documentação Atualiza arquivos básicos de documentação Sep 16, 2022
@trevineju trevineju self-assigned this Sep 25, 2022
@trevineju trevineju mentioned this pull request Feb 10, 2023
@trevineju
Copy link
Member Author

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:

  • no contributing.md, discriminar a configuração do ambiente em 3 sistemas operacionais (linux, macOS e windows)
  • no contributing.md, mencionar desafios relevantes que o repositório ainda quer/precisa superar, indicando possíveis pontos de contribuição

Copy link
Member

@ogecece ogecece left a 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

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@trevineju
Copy link
Member Author

trevineju commented Feb 22, 2023

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

Copy link
Member

@ogecece ogecece left a 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:

docs/CONTRIBUTING-en-US.md Outdated Show resolved Hide resolved
docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@trevineju
Copy link
Member Author

já aceitei as sugestões e corrigi a história do PR para enxugar os commits @giuliocc

Copy link
Member

@ogecece ogecece left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ogecece ogecece merged commit 65a4e4d into okfn-brasil:main Aug 3, 2023
@trevineju trevineju deleted the atualiza-documentacao branch September 6, 2023 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants