No momento, as maiores contribuições são: utilizar a ferramenta, realizar o experimento e divulgá-la.
Pull requests são sempre bem vindos. Ao participar desse projeto você está de acordo com o código de conduda.
O projeto tem como origem uma pesquisa científica (em andamento) sobre utilização de linguagem de marcação de texto para elaboração de monografias.
Acesse o chat no gitter e fale conosco, independente do seu perfil.
Como professor você pode contribuir com o limarka divulgando-o e ofertando o limarka como uma opção para seus alunos realizarem tarefas.
-
Ao solicitar relatórios de atividades aos alunos, sugira a utilização do limarka. Embora o limarka tenha o propósito de produzir trabalhos de conclusão de curso, ele pode ser facilmente utilizado para elaboração de relatórios.
-
Sugira seus orientandos experimentarem o limarka. O limarka é gratuito e livre, pode ser utilizado no Linux, OS X e Windows. Não recomendamos utilizar o limarka em trabalhos de conclusão que exigam bastante fórmulas, teoremas ou provas. Os editores Latex oferecem melhor suporte para isso.
-
Atualize sua página pessoal/institucional adicionando uma matéria ou link sobre o limarka. Seus alunos e outras pessoas poderão conhecer a ferramenta dessa forma.
-
Solicite incluir o limarka como uma alternativa nos materiais de instruções de produção de trabalhos de conclusão, ou nas disciplinas de Metodologia. O momento ideal para apresentar aos alunos a ferramenta são nas aulas de Metodologia. Por enquanto o foco da ferramenta são trabalho de conclusão, mas em breve também será possível realizar artigos.
-
Divulgue um notícia sobre o limarka nas listas de professores ou alunos. O público alvo da ferramenta são os estudantes, essas listas propocionam encontrá-los.
-
Recomende a veiculação de uma matéria sobre o limarka na agência de noticias de sua instituição. As agências de notícias das instituições são um ótimo meio para divulgação, verifique como contactar agência e recomende uma matéria para ser veiculada.
-
Clique na estrela no repositório do projeto (equivale a um like) no github.
- Utilize o limarka para elaboração de relatórios
- Participe do experimente de uso da ferramenta - NECESSITA-SE URGENTEMENTE!
- Compartilhe alguma notícia do limarka em suas redes sociais ou lista de alunos ou de laboratórios
- Escreva seu trabalho de conclusão ou sua proposta/projeto com o limarka e compartilhe sua experiência
- Clique na estrela no repositório do projeto (equivale a um like) no github.
Gostaríamos de converter as customizações conhecidas do abnTeX2 para utilização com o limarka.
Deseja participar do desenvolvimento do limarka? Considere os issues marcados com o label help needed como um convite para contribuir conosco.
Correção de bugs e implementação de novas funcionalidades através de Pull requests são sempre bem vindos.
Ao participar desse projeto você está de acordo com o código de conduda.
Nós desejamos melhorar a experiência de utilização da ferramenta implementando um site que gere conteúdos dinâmicos.
Suponha que um usuário deseja adicionar uma referência de um artigo, gostaria que o usuário clicasse em "Artigo" e um formulário fosse apresentado para preenchimento e acordo com os campos bib desse tipo de entrada. Quando o usuário vai preenchendo o código bib é gerado automaticamente para inserção no arquivo de referências.
Para compreender a funcionalidade veja o site http://shields.io e clique em algum dos badges.
Crie um issue descrevendo a nova funcionalidade.
Realize um fork no projeto, depois faça o clone do seu fork:
git clone git@github.com:your-username/limarka.git
Configure sua máquina:
./bin/setup
Certifique-se que os testes estão passando:
rake
Escreva o codelog da funcionalidade que deseja implementar:
rake codelog:new[nome-da-funcionalidade]
NOTE: Atualize o arquivo [changelogs/unreleased/XXXXXXXXXXXXXXXXX_nome-da-funcionalidade.yml incluindo texto para release notes.
Realize as alterações. Adicione testes (opicional, mas desejado) para as suas mudanças. Faça os testes passarem:
rake
git add arquivo-modificado1 arquivo-modificado2
git commit
Se existir um Issue referente a funcionalidade implementada utilize o número do issue na mensagem de commit para manter rastreabilidade.
Faça um Push para o seu fork:
git push origin
Submeta um pull request. Altere o título do issue/PR para o texto que deseja ser adicionado ao CHANGELOG
Talvez você deseje consulta a página sobre o desenvolvimento da ferramenta.