Remarcação

Bom dia, colegas! Depois de uma longa jornada de aprendizado, todo mundo quer mostrar ao empregador os seus frutos, e mostrá-los apenas pelo lado melhor, profissional, certo? Acho que sim. Portanto, além de um projeto corretamente desenhado e implementado, precisamos ser capazes de formalizá-lo. O empregador não lerá todo o código do seu projeto para entender do que se trata e o que está incluído nele? Neste artigo, vamos finalmente resumir os dois anteriores, a saber: Integração Contínua e Cobertura de Código , e deixar-nos entender na folha “frente” do projeto open source o que usamos em nosso projeto e o que isso representa. Hoje falaremos com vocês sobre Markdown, faremos nossas perguntas favoritas: “O que é isso?” e “Por que isso?”, vamos descobrir onde ele é usado e como trabalhar com ele. Haverá até um exemplo, vamos implementá-lo em nosso projeto de código aberto . Então vamos!

O que é “Markdown”?

Como você e eu somos programadores, iremos imediatamente ao Google e abriremos o primeiro link do Wiki , que diz: Markdown é uma linguagem de marcação leve criada com o objetivo de escrever o texto mais legível e fácil de editar, mas adequado para conversão para idiomas para publicações avançadas (HTML, Rich Text e outros). Aqui, para ser sincero, não tenho muito a acrescentar, acho que esta é uma explicação quase perfeita.

Por que precisamos deste "Markdown"?

Para ser honesto, na verdade não é ruim sem ele :D Mas vamos lembrar nosso objetivo: escrever um modelo de projeto competente que já tenha Integração Contínua e tenha estatísticas de Cobertura de Código no recurso Codecov. Por que mencionei isso? Além disso, o Markdown nos permitirá obter dados desses recursos e fornecer os próprios dados, ou crachás que nos redirecionarão para onde precisamos obter essas informações. É conveniente ter tudo em uma página de “título”, em vez de espalhado em lugares diferentes, não é?

Onde é usado?

Qualquer pessoa que tenha carregado algum de seus projetos no GitHub pelo menos uma vez sabe que o GitHub deseja persistentemente convidá-lo a criar um arquivo README: Qual é a extensão deste arquivo? Isso mesmo, Bolt conhece Markdown! Como já sabemos, este arquivo é facilmente ajustado a vários formatos e convertido no HTML que necessitamos. Mas vamos não ter pressa e não nos apressarmos em adicioná-lo imediatamente e diretamente ao GitHub.

Como trabalhar com isso?

Primeiro, como você deve ter notado, podemos adicioná-lo diretamente ao GitHub e funcionará! Mas nem sempre precisamos adicioná-lo a apenas um projeto, por exemplo. Ou, por exemplo, queremos pensar mais sobre como o criamos. E aqui o GitHub não é mais adequado para nós. E, em geral, podemos criar arquivos Markdown não apenas com o propósito de enviá-los para o GitHub. Em segundo lugar, poderíamos criá-lo diretamente através do IDEA, que é exatamente o que faremos, mas não imediatamente, porque precisamos de um ambiente de desenvolvimento poderoso para escrever um pequeno arquivo? Aqui eu recomendo navegar no catálogo de editores de arquivos Markdown fáceis e não tão fáceis. Para mim, escolhi o Haroopad , é muito simples, acessível, tem uma representação instantânea do que você está escrevendo (o IDEA também) e tem uma dica de sintaxe. Esta é a aparência da janela do editor: Aqui abri um README.md pronto para uso de um dos meus projetos. À esquerda está uma folha de dicas, à direita um display, no centro está um texto. Tudo é muito primitivo e simples. Você também pode ver os emblemas, dos quais falaremos em breve. Quem optar por uma forma diferente de escrever esses arquivos - não se assuste, a única diferença será a interface gráfica. O texto, a sintaxe e a exibição permanecerão inalterados. Exemplo A tarefa é muito simples: escrever README.md para que contenha: informações sobre o projeto (incluindo emblemas), informações sobre a importação do projeto, informações sobre a implementação do projeto, informações sobre os contatos do autor. Tudo é muito simples e primitivo, como já disse. Vamos ao que interessa.

1. Vamos escrever um título – o nome do nosso projeto.

   O título principal e maior é criado usando o operador hash “ # ” e então o título é escrito. No nosso caso:

   # ForJavaRushPublication

2. Depois escreveremos um título um pouco menor e escreveremos "Informações do Projeto". O cabeçalho menor é precedido por mais " # ":

   ## Information

   E então escreveremos informações sobre o projeto.

3. Vamos inserir links para nossos artigos. Isso é feito de forma muito simples, e se você usar o Haroopad, basta digitar a folha de dicas e o modelo será inserido. A sintaxe é: " [texto](url) ";

4. Vamos inserir emblemas. Vamos dar uma olhada mais de perto aqui.

   Primeiro, vamos organizá-los em forma de mesa, para ficar mais bonito. Haverá 2 colunas e 2 colunas. A sintaxe será semelhante a esta:

   E o resultado será assim:

   A seguir, inseriremos hiperlinks para nossos crachás, mas onde podemos obtê-los? No artigo anterior mostrei onde conseguir o Codecov, mas não mencionei qual pegar. Como temos um arquivo Markdown, também precisamos de um selo Markdown:

   Basta copiá-lo e colá-lo em uma coluna do nosso Markdown. Mas não se esqueça que o Codecov apareceu no branch JaCoCo, mas não no master, então você terá que corrigi-lo manualmente. O Travis CI Badge é colocado diretamente em frente ao nome do projeto, onde o log de construção é:

   Escolhemos o emblema e a janela de configurações aparece:

   Definitivamente selecionamos Markdown e o branch que você precisa. Farei README.md para duas ramificações, e elas serão um pouco diferentes, pois ainda não implementei o Codecov na ramificação master.




5. Vamos escrever informações sobre como importar ou clonar este projeto. Não vou explicar como fazer isso, mas você pode ler em meu README.md. Escreveremos sobre as tecnologias que utilizamos em nosso projeto, colocando links para elas. Ainda assim, este é um projeto educacional. Bem, vamos anotar as informações de contato.




6. Nosso Markdown está pronto. Tudo o que precisamos fazer é adicioná-lo ao nosso projeto e pronto. Mas não tudo ao mesmo tempo! Vamos abrir nossa IDEA, e em Plugins verificamos se você possui Markdown Support:

   Eu tenho o Ultimate IDEA, então tenho tudo, seu plugin pode não estar instalado por padrão, mas ao criar um arquivo com a extensão md, você deverá ser solicitado a baixá-lo. Baixe e reinicie seu IDEA.




7. Após importar o Markdown que escrevemos, abra-o através do IDEA e edite-o se necessário. Isto é o que parece via IDEA:

   Nós empurramos. Então vemos que ao abrir um projeto, as informações sobre ele são imediatamente carregadas, este é o nosso README.md:

   Agora, ao clicarmos no crachá, podemos ir direto para a montagem do projeto e ver o que temos lá e como.




8. Farei o mesmo para o branch JaCoCo para demonstrar o Codecov Badge, porque ainda não temos README.md nele. Como resultado, agora temos dois emblemas:

   Codecov mostra a porcentagem de cobertura de código e também pode nos redirecionar para a página Codecov e mostrar um relatório detalhado de cobertura de código.

Links Úteis

• O que o Wiki nos diz sobre Markdown;
• Diretório de Editores Markdown ;
• Haroopad que recomendo;
• Sobre Markdown no site da JetBrains ;
• Markdown Navigator no mesmo JetBrains;
• Emblemas e tudo sobre eles. Aqui você pode escolher o estilo de qualquer crachá e personalizá-lo;
• Como atualizar seu projeto de código aberto? Este artigo também responderá ;
• Artigo anterior

Vamos resumir a série de meus artigos

1. Vimos o que é CI, para que serve e como utilizá-lo no primeiro artigo sobre Integração Contínua ;
2. Brincamos com CC e entendemos o que é e por que é necessário no segundo artigo sobre Code Coverage ;
3. E neste artigo vimos o que é Markdown, por que é necessário e como usá-lo de forma eficaz.

Obrigado a todos por lerem estes três longos artigos, espero que tenham sido úteis. Pode haver erros e omissões no texto. Obrigado a todos pela atenção!