Home

Wiki do projeto Zeus.Net.NFe.NFCe

Diretrizes para contribuir com código

A comunidade inteira agradece sua colaboração, mas afim de mantermos a qualidade da biblioteca, segue abaixo uma lista de diretrizes:

1 - A contribuição deve ser feita via pull request. Se não conhece o github dê uma olhada nesse tutorial: http://blog.da2k.com.br/2015/02/04/git-e-github-do-clone-ao-pull-request/ ou https://www.google.com.br/webhp?sourceid=chrome-instant&ion=1&espv=2&ie=UTF-8#q=como+usar+o+github

2 - Os nomes das classes e atributos constantes no manual de orientação do contribuinte devem ser escritos conforme constam no manual, respeitando o case sensitive da documentação. Ex: Se o atributo/classe começar com caractere minúsculo, colocá-lo assim no c#;

3 - Os nomes de métodos/atributos e classes de apoio devem ser escritos em português;

4 - Todas as classes/atributos/métodos devem ser documentados no formato xml. A documentação dos atributos e classes do projeto *.Classes deve conter o código e descrição conforme consta no manual de orientação do contribuinte e conforme pode se ver no projeto NFe.Classes;

5 - Se a documentação XML dos atributos/classes/métodos fizer referência a um objeto, usar a tag . Ex:

/// <summary>
/// Obtém um objeto contendo o certificado digital
/// <para>Se for informado <see cref="ConfiguracaoCertificado.Arquivo"/>, 
/// o certificado digital será obtido pelo método <see cref="ObterDeArquivo(string,string)"/>,
/// senão será obtido pelo método <see cref="ObterDoRepositorio()"/> </para>
/// <para>Para liberar os recursos do certificado, após seu uso, invoque o método <see cref="X509Certificate2.Reset()"/></para>
/// </summary>

6 - Todas as classes deve conter um comentário no cabeçalho, informando sobre a licença e os direitos de uso;

7 - O código deve ser compatível com o .NET 4.0 e VS2013 em diante (pode ser revisado no futuro);

8 - Pulls requests não são anexados automaticamente ao projeto, eles estarão sujeitos à avaliação prévia antes de integrar a biblioteca;

9 - Antes de iniciar uma implementação, informe-se na comunidade aqui no git ou no skype, pois outro pode já estar desenvolvendo-a.