cc.uffs.edu.br
cc.uffs.edu.br copied to clipboard
Melhorar o README
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.
20 horas de ACCs fáceis :)
PS: as horas de ACCs da categoria de contribuição de software livre só valida 50% das horas.
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.
@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.