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

Improvements in the README #32

Open
3 of 10 tasks
yogodoshi opened this issue Oct 26, 2017 · 0 comments
Open
3 of 10 tasks

Improvements in the README #32

yogodoshi opened this issue Oct 26, 2017 · 0 comments

Comments

@yogodoshi
Copy link
Owner

yogodoshi commented Oct 26, 2017

@maurogeorge gave some improvement suggestions:

  • "No README trocar "Sobre o projeto" por "Cansei" e manter o mesmo texto. Só adicionar que é uma aplicação Rails em algum lugar dele."

  • "Se rolar, seria legal neste começo fazer um gifzinho da App rodando. Tipo:

  1. clico no "Entrar"
  2. faz um fade in para algum tempo depois...
  3. e mostra o tweet no twitter.

Eu demorei um pouco para entender o fluxo. Eu tinha entendido a proposta, mas não o fluxo.
O discourse tem imagens e o conf-boilerplate tem um vídeo."

  • "Antes do "Como usar o projeto", cria um "Dependencies". Algo na linha que o Pah gera: https://github.com/Helabs/pah/blob/master/lib/pah/files/README.md#dependencies"

  • "Trocaria o "Como usar o projeto" por "Setup" e manteria os demais blocos que escreveu, só vemoveria o 1., 2. etc dos titulos. Aqui incluiria apenas os 1, 2 e 3."

  • "Criar uma sessão "Running the project" Na linha do https://github.com/Helabs/pah/blob/master/lib/pah/files/README.md#running-the-project. Acho maneiro já incluir como rodar as specs aqui também."

  • "Tanto o deploy quanto o Teste por uns dias ser títulos H1, mantendo sua própria sessão."

  • "Na parte do deploy:

    • Faltou explicar o minimo do heroku toolbelt(talvez tenha no item 3, mas não custa nada um passo 2 instale o toolbelt), nem que seja um link para o cara instalar, pois se o cara tentar dar o git push que você orienta não vai pra lugar algum.
    • Faltou dizer que tem que colocar o heroku scheduler.
    • Acho que tem que ser $ heroku run rake db:migrate"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant