Contribua

Como contribuir com este projeto?

1. Faça o fork do projeto em https://github.com/Dirack/Shellinclude/fork

Este projeto é open source e distribuído sob a lincença GPL3.

2. Crie uma branch para sua modificação (git checkout -b feature/suaNovaFeature)

Use um nome de branch claro e com contexto. Exemplo, 'feature/saidaProgramaMorseEmJSON' é melhor que 'feature/morse'.

3. Faça o commit com uma mensagem clara (git commit -am 'Add nova suaNovaFeature'`)

O histórico de commits é tão importante para este repositório quanto o conteúdo de suas modificações. O padrão Aqui utilizado é de mensagens de commit com o título de no máximo 50 caracteres e um a dois parágrafos descrevendo cada modificação. Pull Requests com histórico de commits insuficiente serão rejeitados.

Se a modificação for muito pequena (como o valor de uma variável, ou uma linha de código) o commit poderá ter apenas o título da mensagem de commit. Porém, para modificações mais significativas os commits devem ter título e mensagens como descrito no parágrafo anterior.

Evite comentar o código para explicar a lógica de suas modificações, isto pode ser feito nas mensagens de commit mais extensivamente. Se a sua explicação for muito longa (mais de dois parágrafos), é melhor dividir as alterações em mais commits com mensagens mais claras e curtas.

Utilize nomes de variáveis claros e com contexto. Exemplo, 'ARQUIVO_TEMP' é melhor que 'TMP', ou 'NOME_USUARIO' é melhor que 'NOME'.

4. Faça o Push das suas modificações no seu repositório (`git push origin feature/suaNovaFeature``)
5. Crie um novo Pull Request com uma descrição clara de suas modificações

Qual o padrão das mensagens de commit utilizados neste repositório?

Importante: O histórico de suas modificações deve ser claro, com mensagens de commit de um a dois parágrafos descrevendo cada modificação. Pull Requests com histórico de commits insuficiente serão rejeitados.