docs: README principal em inglês, original preservado em português - #42
Merged
Merged
Conversation
O repositório é público e serve de referência em candidaturas a programas de pesquisa no exterior, onde o avaliador não lê português. O texto em inglês passa a ser o principal e o original vira README.pt-BR.md, com link recíproco entre os dois. Nada foi removido, inclusive os créditos da equipe. A ordem também muda: o achado metodológico sobre ancoragem em regra de linter vem antes do contexto de disciplina, porque é o que tem valor para quem lê de fora.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivo
O repositório é público e serve de referência em candidaturas a programas de pesquisa no
exterior. Hoje o README está em português, e os avaliadores desses programas não leem
português. Na prática, quem abre o link não consegue avaliar nada.
O que muda
README.mdpassa a ser a versão em inglês. O texto original viraREADME.pt-BR.md, com linkrecíproco entre os dois no topo. Nada foi removido, inclusive os créditos dos três
integrantes do grupo.
A ordem das seções também muda. O original abria com o contexto de disciplina e chegava ao
achado metodológico na décima linha. A versão em inglês abre com o achado, que é o que tem
valor para quem lê de fora: ancorar a mineração em regra de linter multiplica o rendimento
de pares válidos por 5 a 25 vezes, e o multiplicador escala com a objetividade do critério
do smell.
As três decisões que mantêm o dataset honesto (oracle firewall, split por repositório,
sonda de qualidade antes do treino) ganharam seção própria, porque são o que diferencia
este trabalho de uma coleta ingênua.
O contexto de disciplina continua no texto, e a redução de escopo de 12 smells para 5
segue declarada. Só deixaram de ser a primeira coisa que se lê.