Contribua

Como contribuir com este projeto?

A seguir a descrição detalhada do passo-a-passo para contribuir com este projeto:

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

Este projeto é de código aberto e distribuído sob a lincença GPL3. Ao fazer o fork você automaticamente concorda com os termos dispostos nesta Licença de uso.

2. Crie uma branch para sua modificação.

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

Adicione cabeçalhos aos seus códigos fonte ou modifique os cabeçalhos já existentes seguindo o template abaixo:

#!/bin/bash
#
# nomeDoPrograma (Shell Script)
#
# Dependências: -lynx. Utilize 'sudo apt-get install lynx' para instalar.
#
# Objetivo: Baixar arquivos SConstruct da página do MADAGASCAR para a pasta atual
# no formato correto do SConstruct.
# 
# Site: http://www.dirackslouge.online
#
# Versão 1.0
#
# Programador: Rodolfo A. C. Neves 30/06/2019
# 
# Email (Manutenção): rodolfo_profissional@hotmail.com
# 
# Licença: GPL-3.0 <https://www.gnu.org/licenses/gpl-3.0.txt>.

3. Faça o commit com uma mensagem clara (título de no máximo 50 caracteres e dois parágrafos de texto).

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. Faça referências a outros commits e issues se for necessário.

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 e funções claros e com contexto, em camelCase para funções e caixa alta para variáveis. Exemplo, 'ARQUIVO_TEMP' é melhor que 'TMP', ou 'NOME_USUARIO' é melhor que 'NOME'. E 'formataNomeDiretorio' é melhor que 'fmtdir'.

4. Faça o Push das suas modificações no seu repositório.

5. Crie um novo Pull Request com uma descrição clara de suas modificações.

O seu Pull Request deve ter uma descrição mais detalhada das modificações e do propósito delas, utilize imagens e trechos de código para detalhar a sua contribuição sempre que possível.

Acrescentar exemplos de uso e testes ao seu Pull Request aumenta a probabilidade de aceitação. Não esqueça de documentar estes testes e exemplos em arquivos README e agrupá-los em um diretório separado.