Skip to content

nettobruno/blog

Repository files navigation

blog

Este projeto foi uma iniciativa do Guilherme Cezário, que me fez um convite para participar.

A ideia é ter uma forma de compartilhar o conhecimento que adquirimos, com pessoas que estão iniciando na área e passam por dificuldades ao entender determinados assuntos. Queremos explicar diversos conceitos de uma forma extremamente didática e simples.

Requisitos para rodar o projeto:

Setup de ambiente

  • Node na versão 16.17.0
  • NPM na versão 8.15.0

Como rodar na minha máquina?

  • Clone o projeto git clone https://github.com/nettobruno/blog.git
  • Rode npm install
  • Rode npm run dev
  • Pronto, o projeto já estará rodando em sua máquina 😁

✅ Features

  • Padronização de commits
  • Padronização de escrita de código
  • Página incial definida
  • Página de artigos definida
  • Página com informação dos autores
  • Definir um histórico de melhorias(changelog)

🛠 Tecnologias

  • NextJS
  • Tailwind CSS

Como fazer um commit?

Na primeira vez que você for realizar um commit, caso ainda não tenha em sua máquina, será necessário instalar o commitizen. Instale-o globalmente no seu computador usando o seguinte comando: $ npm install --global commitizen

Após realizar as mudanças, adicione-as ao stage e rode o comando: $ npm run commit

Depois de rodar o comando acima, responda as seguintes perguntas:

# Select the type of change that you're committing:
Das opções listadas, selecione a que esteja de acordo com a alteração realizada. Ex: fix

# What is the scope of this change (e.g. component or file name):
Responda inserindo o nome do componente ou arquivo em que fez a alteração. Ex: changelog

# Write a short, imperative tense description of the change (max 83 chars)
Escreva uma breve descrição sobre o que foi feito na modificação

# Provide a longer description of the change: (press enter to skip)
Neste ponto, caso ache necessário, é possível adicionar uma descrição mais detalhada sobre aquele commit

# Are there any breaking changes? (y/N)
Nesta opção, digite: N

# Does this change affect any open issues?(y/N)
Nesta opção, digite: N

Após responder todas as perguntas o commit é realizado e será possível efetuar o push.


Contribuindo

  1. Crie um fork do projeto
  2. Crie sua feature branch: git checkout -b my-new-feature
  3. Adicione os arquivos modificados: git add .
  4. Faça um commit com suas alterações. Lembre-se de seguir o padrão de escrita de commits citada no tópico anterior: npm run commit
  5. Faça um push da sua branch: git push origin my-new-feature
  6. Envie um Pull Request para esse repositório. Lembre-se de que o Pull Request deve ter um título e uma descrição de fácil entendimento
  7. Depois que seu pull request for mergeado, por favor, apague a sua branch

Autores

Bruno Netto Guilherme Cezário