Como contribuir como membro

1. Relatar um bug
2. Relatar uma falha de segurança
3. Criar uma nova funcionalidade
4. Pedir ajuda na lista de discussão
5. Ajudar pessoas com dificuldades na lista de discussão
6. Transformar as dúvidas mais frequentes da lista de discussão em itens do FAQ
7. Contribuir com a documentação
8. Contribuir com conteúdos diversos
9. Organize eventos, dê palestras
10. Criar material promocional
11. Escrever posts no seu blog sobre o i-Educar
12. Discutir como o i-Educar pode ser melhorado nas listas de discussão
13. Créditos

No Software Livre, existem diversas formas para contribuir com a melhoria de um software. Você não precisa ser um hacker de PHP nem de PostgreSQL para contribuir com o i-Educar (mas se for, ficamos muito agradecidos!). Algumas formas de contribuir são:

Relatar um bug

Relatar um bug ajuda os desenvolvedores do i-Educar a corrigir de forma mais rápida um comportamento não desejado. Nós usamos o sistema de issues do Gitlab para coordenar a correção de bugs. Antes de abrir uma nova issue, pedimos que siga alguns passos antes de relatar o bug:

1. Verifique se o bug já não foi relatado com uma issue;
2. Não crie uma issue caso já exista uma para o bug (mesmo que a descrição seja um pouco diferente). Caso queira acrescentar alguma informação sobre o bug que possa ser útil, crie um comentário na issue já existente;
3. Consulte a lista de discussão para ver se já existe algo parecido. Pode ser que você tenha esquecido algum passo na instalação ou na configuração;
4. Nunca use o sistema de issues para solicitar suporte. Use a lista de discussão para esse propósito.

Ao fazer os passos acima e não encontrar nada semelhante ao que achou, você pode ter se deparado com um bug. Preencha o formulário para cadastrar uma nova issue.

Lembre-se: Caso já tenha desenvolvido a correção, crie mesmo assim a issue submeta sua correção.

Relatar uma falha de segurança

Falhas de segurança serão tratadas de forma diferente de outros bugs. Caso encontre uma falha de segurança, por favor, envie um e-mail para tgiusti [arroba] gmail [ponto] com. Este e-mail encaminha uma mensagem ao Coordenador da Comunidade i-Educar. Sua falha será analisada e você terá uma resposta sobre como o problema será corrigido e qual a previsão da liberação da correção. Enquanto isso, pedimos que não torne a falha pública.

Criar uma nova funcionalidade

Se você alterou o código fonte do i-Educar para criar uma nova funcionalidade ou irá criar uma para alguma necessidade específica, contribua com o projeto disponibilizando-a em nosso repositório.

Caso encontre alguma issue com pedido de nova funcionalidade que julgar ser interessante desenvolver e esteja disposto a fazê-lo, atribua a issue para si (colocando o seu nome usuário no campo Assignee da issue).

Pedir ajuda na lista de discussão

A primeira vista pode nem parecer mas um simples pedido de ajuda na lista de discussão pode contribuir muito para a comunidade e para o projeto:

• Sua dúvida pode ser a dúvida de alguém que não teve coragem de perguntar;
• Ao ser respondida, outras pessoas analisarão a dificuldade enfrentada e sugerirão alguns passos que podem vir a:
  • complementar a documentação oficial ou;
  • ajudar na identificação de um bug até então desconhecido;
• Estimula a participação de outros usuários a darem seu feedback.

Para pedir ajuda, utilize a lista de discussão.

Ajudar pessoas com dificuldades na lista de discussão

Ajude a responder dúvidas na lista de discussão. Isso evita que novos (e antigos) usuários fiquem frustrados e que desistam do i-Educar. Lembre-se: o feedback deles é essencial na identificação de novos bugs e para identificação de pontos falhos na documentação e na usabilidade do software.

Transformar as dúvidas mais frequentes da lista de discussão em itens do FAQ

Com o tempo, as mesmas dúvidas aparecerão na lista de discussão. Ao identificar uma dúvida frequente, atualize o FAQ criando uma nova entrada com a pergunta/dúvida como título e com uma resposta para a mesma. Se você tiver dificuldade ou dúvida em como fazer, envie uma mensagem para a lista de discussão pedindo a Coordenação da Comunidade para fazer a atualização do FAQ.

Contribua com documentação

Uma boa documentação é determinante para o sucesso de um projeto de Software Livre. Contribua com a documentação, seja ela técnica ou de uso do software. Padrões para a criação de documentação ainda serão definidos mas não espere por eles: contribua! Tenha um cuidado a mais com o português e tente ser o mais simples possível.

Nossa documentação é toda centralizada nessa wiki. Qualquer um com uma conta na comunidade i-Educar no Portal do Software Público pode alterar a documentação, seja para corrigir erros ou para contribuir com mais um tópico.

Contribua com conteúdos diversos

Se você puder, ajude a comunidade criando manuais de utilização, implementação, screencasts (vídeo aulas) ou qualquer conteúdo interessante que possa ser útil e relevante para desenvolvedores ou usuários finais.

Compartilhe seus materiais na lista de discussão identificando os dados do autor com nome completo, e-mail, instituição/empresa e site que foi responsável pela produção e iremos divulgar em nossos canais oficiais: wiki, blog, e-mail marketing, redes sociais.

Organize eventos, dê palestras

Organize algum evento: um code sprint, seminário, mesa redonda, desconferência (não importa o tamanho!) e divulgue/explique o que é o i-Educar. Convide educadores! Divulgue suas palestras na lista de discussão, informe o tema de seu evento (título da palestra, objetivo, etc) e data com um link para maiores informações (como local do evento, valor da entrada, entre outras).

Tem algum evento interessante próximo aceitando propostas de palestras? Crie uma e envie. Você irá se divertir compartilhando conhecimento e terá um feedback muito bom! Depois, compartilhe seus slides/anotações fazendo upload de seu material em seu blog ou em sites como o Slideshare e compartilhe com a comunidade por meio da lista de discussão.

Crie material promocional

Tem algum aptidão em redação ou artes gráficas (ou uma imensa boa vontade)? Ajude a criar material promocional para o i-Educar como apresentações em slides, screencasts, cartilhas e badges para uso em sites. Procure licenciar este trabalho com alguma licença Creative Commons. Envie seu material por meio da lista de discussão para compartilharmos com os demais e adicionarmos um link para o seu trabalho aqui na wiki.

Escrever posts no seu blog sobre o i-Educar

Escreva sobre o i-Educar. Diga o que pensa, o que gostaria que acontecesse, divulgue as boas novas. Compartilhe na lista de discussão o link para o seu blog (mais especificamente para a página que lista os posts relacionados com o i-Educar).

Discutir como o i-Educar pode ser melhorado na lista de discussão

Seja um cidadão i-Educar. Participe de nossa democrática comunidade na lista de discussão e nas conferências em vídeos (hangout, etc) que ocorrem de tempos em tempos dando sugestões e discutindo melhorias. Seja educado e evite responder de forma agressiva a insinuações (ou simplesmente as ignore). Use o bom senso!

Créditos

Grande parte desta documentação foi construída com base na documentação iniciada por Eriksen Costa na versão anterior do Portal do SPB. Algumas partes também foram inspiradas no symfony "How to contribute" que inspirou-se em alguns trechos do Django Contributing to.