Skip to content

About

Template do Readme para padronização de documentação de projetos do GitHub.

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

Título do projeto

Descrição do projeto

Made by Wesley Yago Last Commit Contributors License Check out my LinkedIn!


🗺 Tabela de conteúdos


🧪 Como funciona

(Descrição da regra de negócio e fundamento teórico)

Ainda não entendeu a premissa desse projeto e como ele pode ser útil? Observe o tópico abaixo "Exemplo na prática" para entender melhor.


🔨 Exemplo na prática

(Descrição de como a aplicação implementa essa lógica na prática)

Gostou e quer testar a aplicação na sua máquina? O tópico abaixo "Testando na sua máquina" pode te ajudar nisso.


🚀 Testando na sua máquina

(Passo a passo de como baixar e executar o projeto em qualquer máquina)

Requisitos básicos

Instruções de uso

  • escolha uma pasta e execute o Git Bash (clique direito na pasta -> Git Bash Here)

  • clone esse repositório na sua máquina

git clone https://github.com/HypThaNyx/ReadmeTemplate.git
  • entre na pasta do projeto
cd ReadmeTemplate
  • rode o comando a seguir para rodar os testes unitários:
dotnet test | mvn test
  • voilà!

⛳ Features

  • Features já implementadas com sucesso.
  • Features ainda a implementar

📋 Documentação

Esse projeto segue as seguintes Commit Guidelines:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests
  • chore: Misc content

📌 Apoio

Entre em contato e preste apoio através das seguintes redes:


📝 Licença

License

Esse projeto está licenciado sob a licença do MIT - veja o arquivo de LICENÇA para mais detalhes.


🧰 Sendo desenvolvido por Wesley Yago!

About

Template do Readme para padronização de documentação de projetos do GitHub.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors