rio-covid-19 / rio-covid-19.github.io

https://rio-covid-19.github.io
Mozilla Public License 2.0
1 stars 0 forks source link

Repositório do site informativo sobre a iniciativa Núcleo de Reparo de Ventiladores Mecânicos.

Objetivos do repositório

Contribuições para o site

Toda contribuição é bem-vinda para melhor permitir a divulgação das informações. No entanto, precisamos seguir algumas recomendações antes de implementar alguma mudança, visto que teremos várias pessoas trabalhando em conjunto. Em suma, é necessário ter conversa. E o lugar para começar isso é na aba de Issues. Lá discute-se perguntas e sugestões antes de realizar qualquer modificação nos códigos. De vez em quando pode acontecer de uma pessoa não entender o que a outra escreveu (principalmente se não a conhece pessoalmente), mas pode ter certeza que ninguém está distribuindo desaforos. Tenha empatia, criatividade e gargalhadas para contornar a situação. :sunglasses:

Há duas formas principais de contribuir, seja criando conteúdo, seja ajeitando as configurações. Por questões de integridade e bom funcionameto do site, é boa prática não realizar as mudanças diretamente no ramo (branch) master. Assim, temos dois ramos adicionais (doc e config) para acomodar os dois tipos de contribuições comentados. As seções a seguir detalham como proceder com as edições online, ou seja, diretamente pelo site do GitHub.

Editando o conteúdo

  1. Altere para o ramo doc e escolha o arquivo que deseja modificar.
  2. Neste ramo, o mais comum é alterar e criar conteúdos referentes a pasta _posts, pois lá se encontra a maior parte do texto que aparece no site. Utilize o mesmo estilo de escrita daqui do GitHub, que utiliza Markdown (arquivo terminado em .md).
  3. Copiar um arquivo já existente ajuda a não ter problemas de configuração, pois cada arquivo de texto possui um header com as configurações da página.
  4. Ao salvar as alterações (commit) utilize um título direto, coloque na descrição o que achar relevante (não tem problema deixar em branco), e certifique-se de ter selecionado a opção de commit diretamente no branch doc.
  5. Aguarde a revisão de sua contribuição.

Melhorando à configuração

  1. Altere para o ramo config e escolha o arquivo que deseja modificar.
  2. Não é recomendado alterar muitas coisas de uma só vez, pois isso dificulta em encontrar erros. Faça alterações por etapas.
  3. Ao salvar as alterações (commit) utilize um título direto, coloque na descrição o que achar relevante (não tem problema deixar em branco), e certifique-se de ter selecionado a opção de commit diretamente no branch config.
  4. Aguarde a revisão de sua contribuição.

Contato

Se ficou em dúvida com alguma coisa ou deseja conversar sobre algo a mais, pode iniciar um Issue e me marcar na descrição utilizando @yurigabrich. Ou enviar e-mail para yuribgabrich@gmail.com.

Agradecimentos