Todos são bem vindos para contribuir com nossos projetos. Diversas formas de contribuição são aceitas - e existem muitas formas de contribuição que são igualmente importantes, incluindo correções ortográficas no Software e reportagem de bugs.
Idependentemente de como você deseja envolver-se com esse projeto nós pedimos que primeiro você leia este documento.
Caso você esteja usando o projeto de alguma forma e deseja nos informar algum bug no código pedimos que você abra uma issue.
Quando for escrever a issue por favor inclua:
- Uma pequena descrição do problema. Se o programa retornou algum erro ou mensagem coloque a linha/parte mais importante do erro. Caso não tenha nenhuma forma de retorno faça uma pequena descrição do comportamento inesperado.
- Uma descrição do ambiente que você está usando. Inclua qual versão do Node, qual Sistema Operacional e qual ambiente (navegador, terminal) você está utilizando.
- Caso já tenha tentado corrigir o bug de alguma forma conte-nos. Inclua qualquer informação de pesquisa, correção ou qualquer outra forma de entender o erro que possa nos ajudar.
- Descreva qualquer mudança que possa ter causado o erro.. Caso o erro tenha acontecido após alguma mudança significativa informe-nos.
- Se possível, nos ajude a reproduzir o problema. Caso seja possível ajude-nos a reproduzir o erro para que possamos depurá-lo.
Pode ser possivel que o erro que você está nos reportando já tenha sido reportado ou até mesmo corrigido por isso faça uma pesquisa nas issues antes de abrir qualquer nova issue.
Nós adotamos uma prática de desenvolvimento de pequenas modificações cada vez. Se possível faça, pequenos commits com suas alterações, isso nos ajuda a evitar conflitos, facilita nossa revisão das mudanças e nos ajuda a integrar com outras mudanças caso seja necessário.
Se você realmente precisar fazer um commit com grandes mudanças que possam causar algum tipo de conflito ou dificuldade de integração por favor abra uma issue nos falando o que foi feito para que possamos conversar antes de submeter qualquer pull request.
O header de licença copyleft protege todo o código desse projeto para que ele seja sempre livre - como em liberdade - e deve estar acima de qualquer arquivo que possua código. Caso queira contribuir garanta que todos os headers estão como o template abaixo e que todos os arquivos o possuem.
O header utilizado é:
/*
* This file is part of LMS Livros Didáticos.
*
* LMS Livros Didáticos is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License.
*
* LMS Livros Didáticos is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Foobar. If not, see <https://www.gnu.org/licenses/>
*/Que em tradução não-oficial pode ser traduzido aproximadamente como:
/* Este arquivo é parte do programa LMS Livros Didáticos
*
* LMS Livros Didáticos é um software livre; você pode redistribuí-lo e/ou
* modificá-lo dentro dos termos da Licença Pública Geral GNU Affero como
* publicada pela Free Software Foundation (FSF); na versão 3 da
* Licença.
*
* Este programa é distribuído na esperança de que possa ser útil,
* mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO
* a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a
* Licença Pública Geral GNU Affero para maiores detalhes.
*
* Você deve ter recebido uma cópia da Licença Pública Geral GNU Affero junto
* com este programa na raiz do projeto, Se não, veja <http://www.gnu.org/licenses/>.
*/