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 #57

Merged
merged 1 commit into from
Aug 10, 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
  • Como não havia CONTRIBUTING.md, o arquivo foi adicionado com layout padronizado e sua tradução em inglês também.
  • Padroniza layout do README.md, modificando pouco o conteúdo que já existia. Adiciona sua versão em inglês.

@trevineju trevineju marked this pull request as ready for review September 16, 2022 20:57
@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
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.

Vamos só complementar o CONTRIBUTING e algumas correções bestas que tá bom!

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

Atendi às modificações e adicionei mais duas:

  1. não tinha linkado o /api/docs no README
  2. fiz edições para seguir o padrão de ter uma versão reduzida do setup no readme e a completa no contributing

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!

Adiciona CONTRIBUTING.md e sua tradução em inglês

Adiciona FUNDING.yml

Adiciona SUPPORT.md e sua tradução

Move e renomeia tradução do README.md

Atualiza texto de LICENSE.md

Atualiza e move arquivos para /docs
@trevineju trevineju merged commit ef087df into okfn-brasil:main Aug 10, 2023
1 check passed
@trevineju trevineju deleted the atualiza-documentacao branch August 10, 2023 19:47
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