Sou iniciante em desenvolvimento de SHELL SCRIPT e no geral rsrs.
Estou iniciando o aprendizado e vou compartilhar o trabalho com uma equipe de
6 desenvolvedores que trabalham em PHP, MYSQL, e C.
Minha missão é desbravar o caminho ANTES (boi de piranha) montando código que
será compartilhado pelo restante da equipe.
Embora as convenções não sejam OBRIGATÓRIAS no mundo do desenvolvimento, é uma
boa prática adotar padrões já utilizados para facilitar reaproveitamento de
código, documentação e aprendizado.
No meu caso não tenho opção rsrs, tenho que tentar fazer o melhor no adoção dos
conceitos e eles serão seguidos pela equipe após aprovados.
Gostaria de receber um feedback de todos que aceitarem participar.
A comunidade pode fazer como sempre fez, mas a nossa equipe tentará adotar este
padrão que irei tentar com a ajuda dos demais, definir.
Tudo que for deixado de lado agora poderá ser completado é claro, mas se for
feito antes enquanto não tenho nada, melhor.
Vou ficar responsável pelas documentações e sou eu que vou sofrer caso
alguma coisa importante fique de fora.
Um colaborador do VOL sugeriu que o código e os texto fiquem em 80 caracteres
e já estou adotando isto como exemplo ao digitar este texto, rsrs.
Só pra entrar no clima.
Segue abaixo algumas convenções minimalistas já elaboradas e seguidas por mim.
============ INICIADO abaixo =================================================
#!/bin/bash
#
# - Faz acesso exclusivo a um determinado arquivo e atualiza seu contador.
# retorna info do contador e dispara processos em arquivos.
# Esta rotina tem a finalidade de eliminar serviços residentes no cron.
# Hoje temos mais de 350 serviços no cron e isto é insustentável.
#------------------------------------------------------------------------------
# name: CheckContador.sh
# since: 2011-08-04 17:58 (GMT -03:00)
# author: Geraldo T. Albuquerque - Twitter: @AprendiNoLinux
# more: http://aprendinolinux.wordpress.com/
#
###############################################################################
# TODO: Script de estações até solucionar controle de processos remotos.
# -----------------------------------------------------------------------------
# XXX: Cenário ideal: Serviço roda no servidor e verifica pasta virtual ssh.
# Cada estação deve fazer solicitações de contadores.
# Serviço rodando no server deve fazer processamento e devolver retorno.
# Estações recebem retorno e executam seus processamentos.
# São mais de 50 máquinas que tentam acesso a vários arquivos de contadores.
# -----------------------------------------------------------------------------
# TODO - Indica uma tarefa a ser feita ou pendência.
# FIXME - Use para indicar um bug conhecido e precisa ser arrumado
# XXX - Enviar um recado importante no ponto.
# -----------------------------------------------------------------------------
# Convenções padronizadas no Script. Padrao.txt contém todas as convenções.
# -----------------------------------------------------------------------------
# Variáveis GLOBAIS serão MAIÚSCULAS. Se forem liga desliga 0=desliga 1=ligado.
# Variáveis locais ou temporárias sempre em minúsculo. "_" separa nomes.
# Nome de função sempre iniciar com "_" e capitalizada ex: _MinhaFuncao()
# Dentro das funções, sempre definir a variável como local ao nomea-las.
# Sempre incluir pelo menos as opções -h, --help, -v, -V, e -q
# -----------------------------------------------------------------------------
# Qualquer Alteração efetivada deve ser notificada no Alteracoes.txt.
# A cada NOVA versão deve ser atualizado o arquivo Noticias.txt
# Registrar em Noticias.txt os créditos de contribuidores da versão.
#
# -----------------------------------------------------------------------------
###
============ FINALIZADO acima =================================================
O arquivo Padrao.txt irá conter todas as sugestões de forma detalhada para cada
tipo de trabalho. Desde a criação de variáveis lógicas, chaves, textos, scopo.
Formas estruturadas para a passagem de parâmetros a scrips externos de outras
linguagens e para funções internas ou bibliotecas genéricas de funções.
Em alguns casos, o arquivo Padrao.txt não será seguido, porém tentaremos ao
máximo implementar seu uso dentro de nossa equipe.
-------------------------------------------------------------------------------
Alteracoes.txt será o arquivo de changelog contendo todas as alterações feitas.
Para este arquivo, um mínimo de convenção também será adotado.
-------------------------------------------------------------------------------
Noticias.txt deverá conter de forma convencionada os detalhes importantes da
versão liberada. É fundamental dar destaque aos colaboradores que de alguma
forma participaram do desenvolvimento.
Válido TAMBÉM para quem realiza importantes testes e encontra BUGS.(erros)
-------------------------------------------------------------------------------
Conforme os enunciados acima, aguardo qualquer contribuição ou material
relevante para que eu possa seguir em frente nesta jornada.
Obrigado antecipadamente pela colaboração de todos.
