Este documento descreve como alguém pode contribuir com o projeto E5R.Tools.Bit, além de definir as diretrizes que devem ser seguidas por cada um que contribui.
Você pode contribuir de 5 formas distintas com esse projeto:
- Divulgando a ferramenta para o maior número de pessoas possível
- Documentando a ferramenta
- Testando a ferramenta e informando problemas
- Estudando a ferramenta e sugerindo melhorias
- Construindo a ferramenta
Abaixo nós temos algumas notas sobre cada uma das formas apresentadas.
A primeira coisa a ser feita, por qualquer que deseje contribuir com este projeto, é ler e aceitar os termos da licença disponível em LICENSE, que no nosso caso é a Apache License, Version 2.0.
Nós queremos que essa ferramenta seja útil ao maior número de pessoas possível, por isso, quando você faz uma divulgação da mesma está contribuindo com esse nosso objetivo de forma direta.
Você pode divulgar a ferramenta nas suas redes sociais (Twitter, Facebook, Instagram, etc.) e em todos os meios que quiser.
O que pedimos é que sempre que você divulgar a ferramenta nas redes sociais, faça uso das hashtags #E5RBit ou #E5R #Bit. Isso vai nos ajudar a tornar relevante o termo e consequentemente indexar todo o conteúdo e tornar possível no futuro encontrar sua divulgação.
Uma outra forma de divulgar bastante apreciada, é você criar artigos e posts em seus blogs pessoais, neles além de só divulgar a ferramenta, você poderia demonstrar seu uso em projetos seus ou expressar sua opinião sobre o assunto, sempre fazendo referência aos links da ferramenta para direcionar o tráfego de possíveis novos adeptos. Segue alguns links:
Nós nos esforçamos ao máximo para produzir uma documentação completa, mas nunca, conseguiremos isso, até porque a prioridade é evoluir a mesma para que esteja o máximo possível livre de bugs, e que tenha as funcionalidades mais relevantes para a comunidade.
Assim sendo, ter uma mão disposta a escrever documentação para o projeto é tão importante quanto escrever o próprio software.
A documentação está contida nesse próprio projeto, até mesmo as documentações que estarão disponível no site oficial da ferramenta (ainda não existe) são geradas à partir de documentos neste repositório. Dessa forma, você deve seguir o Guida do Desenvolvedor para contribuir também com a documentação, além de conhecer o Fluxo de Trabalho para Contribuição.
Da mesma forma que nós nos esforçamos para produzir uma documentação completa, também nos esforçamos para deixar a ferramenta livre de defeitos. Mas da mesma forma, nós também nunca conseguiremos alcançar esse objetivo.
Mas você pode nos ajudar usando a ferramenta em seus projetos e analisando seu comportamento.
E caso encontre algo de errado nos informe abrindo uma issue.
Você também pode encontrar, após suas análises, pontos que podem ser melhorados mesmo
não sendo um problema em si. Às vezes uma nova área que ainda não é coberta, ou talvez
uma nova forma de aplicar uma funcionalidade. Então você também pode nos fazer essa
sugestão de melhoria através de uma issue.
Caso você não queira ou não tenha tempo de procurar por defeitos, ou analisar a ferramenta
para sugerir novas funcionalidades, você pode ao menos baixar o projeto em sua máquina e
executar os testes automatizados. Dessa forma nós podemos garantir que a ferramenta está
funcionando adequadamente em uma maior variedade de configurações de hosts. Aí, se você
encontrar um problema que os testes relatem, você pode nos informar isso numa issue.
Você precisará ler mais sobre como abrir uma issue em nosso Guia para Abertura de Incidentes.
Deveras uma forma mais divertida que você pode encontrar para contribuir com o projeto é ajudando a codificá-la. Leia o Guida do Desenvolvedor, lá você aprenderá o básico de como obter sua cópia do código fonte, configurar seu ambiente, e depurar o código.
Nesse ponto você pode começar a brincar e se divertir da mesma forma que nós. Quando você achar que já consegue entender o mínimo das entranhas do software, tente fazer algumas pequenas mudanças a seu gosto.
Já familiarizado com a ferramenta e como seu código é construído, nós pedimos que você esteja
inteirado com nosso Fluxo de Trabalho para Contribuição, para então
nos ajudar a corrigir os problemas e implementar as novas funcionalidades que estarão
documentadas nas issues do projeto.
Este documento ainda é bem básico, e mesmo depois que incluirmos mais conteúdo não conseguiremos descrever tudo que você precisa para tirar todas suas dúvidas de como você pode contribuir com o projeto.
Mas nós estamos à disposição para conversar sobre o assunto. Sinta-se à vontade para falar conosco em um dos canais abaixo:
