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

Melhorar o README #9

Open
Dovyski opened this issue Aug 6, 2019 · 3 comments
Open

Melhorar o README #9

Dovyski opened this issue Aug 6, 2019 · 3 comments
Labels
ajuda necessária Atenção e ajuda extra são necessárias melhoria Pedido ou feature nova

Comments

@Dovyski
Copy link
Member

Dovyski commented Aug 6, 2019

O README atual não contém informações úteis. Ele deve descrever o projeto de uma forma melhor, particularmente em como os alunos podem contribuir.

Também é preciso informar como rodar o site localmente para que possíveis modificações sejam testadas.

@Dovyski Dovyski added ajuda necessária Atenção e ajuda extra são necessárias melhoria Pedido ou feature nova labels Sep 21, 2019
@dbguilherme
Copy link
Contributor

dbguilherme commented Aug 30, 2022

20 horas de ACCs fáceis :)

PS: as horas de ACCs da categoria de contribuição de software livre só valida 50% das horas.

@joziasmartini
Copy link
Contributor

Essa é outra issue que provavelmente está resolvida (feita por alguém, no passado), @dbguilherme. Eu consegui seguir o README.md para setar o ambiente de forma bem tranquila.

Quem sabe, o arquivo CONTRIBUTING.md poderia ser melhor descrito - atualmente, se não estou enganado, ele segue um modelo conhecido aqui no GitHub, e não contém as particularidades deste projeto.

Outro que cai no mesmo caso é o ROADMAP.md, mas esse é útil quando há alguém planejando e guiando o futuro do projeto, o que não parece ser o caso neste aqui.

@dbguilherme
Copy link
Contributor

@joziasmartini tinha uma inconsistência na biblioteca listen-3.2.1 que precisava ser atualizada para fazer uma nova instalação local. Acabei fazendo um update no GemFile e corrigindo esse erro.

Realmente acredito que a melhoria precisa ser feita no CONTRIBUTING.md descrevendo o passo-a-passo de como fazer um Pull Request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ajuda necessária Atenção e ajuda extra são necessárias melhoria Pedido ou feature nova
Projects
None yet
Development

No branches or pull requests

3 participants