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

Reorganiza documentação #403

Merged
merged 12 commits into from
Nov 8, 2020
Merged

Reorganiza documentação #403

merged 12 commits into from
Nov 8, 2020

Conversation

giovana-morais
Copy link
Contributor

@giovana-morais giovana-morais commented Oct 22, 2020

Descrição do PR
tem a ver com a issue #334, mas não a resolve completamente.
quando a gente fez o Hacktoberladies, eu senti falta de várias coisas na nossa documentação. eu fiz uma sugestão bem geral de organização do documento e adicionei algumas coisas que lembrei, mas tô 100% aberta a comentários porque obviamente não lembro de tudo.

Descrição das mudanças

  • re-organiza o README em seções de linux e windows
  • adiciona também um trecho sobre como rodar no windows sem o docker, que foi o que fizemos no evento
  • adiciona um trecho ao CONTRIBUTING sobre como criar postagens com o windows, que não tem o Makefile
  • adiciona dicas de preenchimento de reviewers e assignees ao pull request

Confirmações
Antes de enviar o Pull Request, faça as seguintes confirmações

  • O PR foi testado localmente
  • (se aplicável) Nenhum link está quebrado
  • (se aplicável) Nenhuma imagem está quebrada

Contexto adicional
Eu recomendo ver o resultado do README por aqui e do CONTRIBUTING por aqui em vez de ver pelo diff.
@biancarosa se cê puder dar uma checada nos comandos pra subir o site sem o makefile, eu ficaria grata pq não tenho certeza deles.

@giovana-morais giovana-morais requested a review from a team October 22, 2020 13:16
@giovana-morais giovana-morais self-assigned this Oct 22, 2020
@giovana-morais giovana-morais requested review from biancarosa and removed request for a team October 22, 2020 13:16
@giovana-morais giovana-morais requested a review from a team October 22, 2020 13:32
@giovana-morais giovana-morais marked this pull request as ready for review October 22, 2020 13:44
@cecivieira
Copy link
Contributor

Pode ser que seja melhor só deixar como rodar no Windows usando o docker. Vou tentar testar de hoje pra amanhã o tutorial do docker e volto aqui.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@biancarosa biancarosa merged commit 7e7878a into master Nov 8, 2020
@biancarosa biancarosa deleted the refactor/documentacao branch November 8, 2020 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants