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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

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:

  • Reorganiza arquivos de documentação para o diretório /docs
  • 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
  • Adiciona arquivos padrão para CONTRIBUTING.md e sua versão em inglês.
  • Padroniza layout do README.md e atualiza seu conteúdo. Issue para versão em inglês será aberta ao aprovar o PR.

@trevineju trevineju marked this pull request as ready for review September 16, 2022 21:26
@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
Copy link
Member Author

No texto do README, não tenho certeza da versão de python e a versão do podman exigida. Copiei de querido-diario-backend

Comment on lines +3 to +25
# Contribuindo
O Querido Diário possui um [Guia para Contribuição](https://github.com/okfn-brasil/querido-diario-comunidade/blob/main/.github/CONTRIBUTING.md#contribuindo) principal que é relevante para todos os seus repositórios. Este guia traz informações gerais sobre como interagir com o projeto, o código de conduta que você adere ao contribuir, a lista de repositórios do ecossistema e as primeiras ações que você pode tomar. Recomendamos sua leitura antes de continuar.

Já leu? Então vamos às informações específicas deste repositório:
- [Desafios](#desafios)
- [Como configurar o ambiente de desenvolvimento](#como-configurar-o-ambiente-de-desenvolvimento)
- [Em Linux](#em-linux)
- [Em MacOS](#em-macos)
- [Em Windows](#em-windows)
- [Mantendo](#mantendo)

## Desafios

## Como configurar o ambiente de desenvolvimento

Lista linguagens/ferramentas utilizadas (com hiperlinks às suas documentações) ou aponta para onde achá-las dentro do repositório
- Mostra os comandos de instalação delas
- Lista dependências necessárias ou aponta para onde achá-las dentro do repositório
- Mostra os comandos de instalação delas

### Em Linux
### Em MacOS
### Em Windows
Copy link
Member

Choose a reason for hiding this comment

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

[salvando pra depois]

A ideia aqui seria por enquanto descrever como esse repositório interage com o de raspadores por meio do postgres mas, pelo menos por enquanto, não mexer nos repos pra tornar isso mais suave.

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