No Projeto ConectaClientes, a equipe da NexoWeb percebeu que não adiantava apenas colocar arquivos dentro do repositório. Para que o trabalho fizesse sentido para qualquer novo membro e para que todos conseguissem colaborar sem confusão, alguns elementos precisavam ser adicionados desde o começo.

O primeiro deles foi o README, um arquivo que funciona como a porta de entrada do projeto. Sempre que alguém abre o repositório do Projeto ConectaClientes, é esse arquivo que explica o que está sendo construído, qual é o objetivo, como rodar o sistema e o que é importante saber antes de contribuir. Ele ajuda a evitar dúvidas repetidas e garante que qualquer pessoa entenda o contexto sem depender de explicações externas.

Outro arquivo importante foi o .gitignore, que cuida de um problema menos visível, mas fundamental. Ele diz ao Git quais arquivos não devem ser acompanhados, como pastas temporárias, arquivos gerados automaticamente ou qualquer coisa que não faça parte da estrutura real do projeto. Isso impede que o repositório fique cheio de itens inúteis e protege informações que não deveriam ser enviadas.

Essas funções do GitHub são para auxiliar você quando utilizar a plataforma para facilitar quem usar o seu repositório ou também para ignorar alguns arquivos que não serviriam para seu código.

O Readme.md é um arquivo de texto que usa a linguagem Markdown e é usado geralmente para explicar o projeto falando como usar, instalar suas dependências e outros fins que seja por texto e informar o usuário.

.Gitignore define quais arquivos não devem ser rastreados pelo Git e evita arquivos desnecessarios sejam enviados para o repositório, ele ajuda a manter o repositório limpo, seguro e organizado, incluindo apenas os arquivos realmente necessários.

 Arquivos Importantes no GitHub

Essas funções do GitHub existem para auxiliar no uso da plataforma, tornando o repositório mais fácil de utilizar e evitando problemas com arquivos desnecessários.

README.md

• É um arquivo de texto escrito em Markdown.
• Geralmente utilizado para:
  • Explicar o projeto.
  • Ensinar como usar.
  • Mostrar como instalar dependências.
  • Incluir outras informações relevantes para o usuário.
• Em resumo: é o cartão de apresentação do seu projeto no GitHub.

.gitignore

• Define quais arquivos o Git deve ignorar.
• Evita que arquivos desnecessários sejam enviados para o repositório.
• Mantém o repositório:
  • Limpo 
  • Seguro 
  • Organizado 
• Inclui apenas os arquivos que realmente importam para o projeto.