ESTE é um trabalho em progresso em seus estágios iniciais, não use na produção. Além disso, você provavelmente encontrará muitos erros e discrepâncias. Seja gentil ao relatá-los, por favor.
Este arquivo foi quase totalmente copiado do arquivo CONTRIBUTING.md de Chris Ferdinandi, um especialista em Javascript baunilha e leve. Você deveria se inscrever para receber suas dicas diárias e comprar os guias VanillaJS em Go Make Things
Antes de postar, faça uma pesquisa para se certificar de que o seu problema ou questões ainda não foram relatados ou discutidos. Se não houver nenhum problema correspondente, vá em frente e crie um. Certifique-se de incluir todos os itens a seguir:
- Um título claro e descritivo (ou seja, "Um bug" não é um bom título).
- Um caso de teste reduzido. (link em inglês)
- Demonstrar claramente o bug ou problema.
- Inclua o HTML, CSS e JavaScript mínimo necessário para demonstrar o bug.
- Um link para seu site de produção não é um caso de teste reduzido.
- O navegador e o sistema operacional que você está usando.
Duplicatas e problemas sem um caso de teste reduzido podem ser fechados sem comentários.
Crie um problema separado para cada solicitação e marque-o claramente como uma solicitação de recurso. Forneça o máximo de detalhes possível.
Se já houver um recurso listado que você gostaria de ver incorporado ao plug-in, adicione seu suporte.
Certifique-se de que seu código atenda aos seguintes padrões de código:
- padrão "camelCase" para variáveis JavaScript.
- CSS orientado a objetos para seletores CSS.
- Favorece o código legível em vez da brevidade. O processo de construção (build process) reduzirá o tamanho, então opte pela legibilidade. (por exemplo,
var navigationé melhor do quevar n) - Ordene as propriedades CSS em ordem alfabética.
- indentações duras (tabs).
Antes de enviar, certifique-se de que você:
- Atualizos o número da versão usando Versionamento Semântico