Conforme as replies na issue #80 e no PR #38, foi discutido alguns pontos cruciais como regras e requisitos a serem seguidos nos futuros e existentes termos do projeto.
Atualmente, muitos "erros" ocorrem em alguns PRs de implementação de novos termos com uma tag atribuída, como: duplicações, tags que não batem com o conceito do termo, tags de linguagens de programação, etc. Muitos desses casos ainda ocorrem e já foram para produção, mas sempre acabam sendo corrigidos em outros PRs. Então, para manter uma maior organização e estabilidade do Diciotech em produção, a documentação do projeto deve conter uma seção exclusiva e detalhada apenas para isso.
O PR #71 adiciona uma parte, na documentação, mas ainda sim é necessário que outros pontos, regras e exigências estejam presentes. As regras sugeridas são as seguintes:
Todas as tags devem estar no singular;
Um termo, de forma obrigatória, deve ser vinculado a, no mínimo, uma tag;
Atualmente, as tags são case sensitivity, então, por padrão, apenas a primeira letra da tag deve ser maiúscula. Exemplo: Back-end, Conceito, Paradigma;
Atribuir a um termo apenas as tags presentes na documentação do projeto;
Se for necessário adicionar uma nova tag, primeiro deve ser aberto uma issue e, caso as pessoas usuárias concordem, um PR deve ser aberto, contendo a tag a ser acrescentada na documentação. A PR sendo aprovada, a nova tag poderá ser vinculada a um termo;
Não pode haver duplicações de tags em um mesmo termo. Exemplo: "tags": ["Conceito", "Conceito"];
Não podem existir tags de linguagens de programação, bibliotecas e frameworks. Exemplo: JavaScript, C#, React.js.
O que acham? Qualquer sugestão ou discordância, essa issue está aberta para os comentários.
Conforme as replies na issue #80 e no PR #38, foi discutido alguns pontos cruciais como regras e requisitos a serem seguidos nos futuros e existentes termos do projeto.
Atualmente, muitos "erros" ocorrem em alguns PRs de implementação de novos termos com uma tag atribuída, como: duplicações, tags que não batem com o conceito do termo, tags de linguagens de programação, etc. Muitos desses casos ainda ocorrem e já foram para produção, mas sempre acabam sendo corrigidos em outros PRs. Então, para manter uma maior organização e estabilidade do Diciotech em produção, a documentação do projeto deve conter uma seção exclusiva e detalhada apenas para isso.
O PR #71 adiciona uma parte, na documentação, mas ainda sim é necessário que outros pontos, regras e exigências estejam presentes. As regras sugeridas são as seguintes:
"tags": ["Conceito", "Conceito"]
;O que acham? Qualquer sugestão ou discordância, essa issue está aberta para os comentários.