cryptoadvocate/dcsgonefwbspO lar do pacote de suporte de placa de firmware do primeiro projeto de crachá eletrônico da Circuit Crafters.
Para facilitar o início com o GitLab, aqui está uma lista de próximos passos recomendados.
Já é um profissional? Basta editar este README.md e personalizá-lo. Quer algo mais fácil? Use o modelo no final!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.git
git branch -M main
git push -uf origin main
Use a integração contínua integrada no GitLab.
Quando estiver pronto para personalizar este README, basta editar este arquivo e usar o modelo prático abaixo (ou sinta-se à vontade para estruturá-lo como quiser – isso é apenas um ponto de partida!). Agradecimentos a makeareadme.com por este modelo.
Cada projeto é diferente, portanto considere quais destas seções se aplicam ao seu. As seções usadas no modelo são sugestões para a maioria dos projetos de código aberto. Lembre-se também de que, embora um README possa ser longo e detalhado, excessivamente longo é melhor do que muito curto. Se você achar que seu README está muito longo, considere usar outra forma de documentação em vez de cortar informações.
Escolha um nome autoexplicativo para o seu projeto.
Deixe as pessoas saberem o que seu projeto pode fazer especificamente. Forneça contexto e adicione um link para qualquer referência que os visitantes possam não conhecer. Uma lista de Recursos ou uma subseção de Contexto também pode ser adicionada aqui. Se houver alternativas ao seu projeto, este é um bom lugar para listar fatores de diferenciação.
Em alguns READMEs, você pode ver pequenas imagens que transmitem metadados, como se todos os testes estão passando para o projeto. Você pode usar Shields para adicionar alguns ao seu README. Muitos serviços também têm instruções para adicionar um badge.
Dependendo do que você está criando, pode ser uma boa ideia incluir capturas de tela ou até mesmo um vídeo (você verá frequentemente GIFs em vez de vídeos reais). Ferramentas como ttygif podem ajudar, mas confira Asciinema para um método mais sofisticado.
Dentro de um ecossistema específico, pode haver uma maneira comum de instalar coisas, como usar Yarn, NuGet ou Homebrew. No entanto, considere a possibilidade de que quem está lendo seu README seja um novato e precise de mais orientação. Listar etapas específicas ajuda a eliminar ambiguidades e faz com que as pessoas usem seu projeto o mais rápido possível. Se ele funcionar apenas em um contexto específico, como uma versão específica de linguagem de programação ou sistema operacional, ou tiver dependências que precisam ser instaladas manualmente, adicione também uma subseção de Requisitos.
Use exemplos generosamente e mostre a saída esperada se puder. É útil incluir o menor exemplo de uso que você pode demonstrar, fornecendo links para exemplos mais sofisticados se eles forem longos demais para serem incluídos razoavelmente no README.
Diga às pessoas onde elas podem buscar ajuda. Pode ser qualquer combinação de um rastreador de issues, uma sala de bate-papo, um endereço de e-mail, etc.
Se você tem ideias para versões futuras, é uma boa ideia listá-las no README.
Informe se você está aberto a contribuições e quais são seus requisitos para aceitá-las.
Para pessoas que desejam fazer alterações no seu projeto, é útil ter alguma documentação sobre como começar. Talvez haja um script que elas devam executar ou algumas variáveis de ambiente que precisem configurar. Torne essas etapas explícitas. Essas instruções também podem ser úteis para você no futuro.
Você também pode documentar comandos para verificar a qualidade do código ou executar testes. Essas etapas ajudam a garantir alta qualidade do código e reduzem a probabilidade de que as alterações quebrem algo inadvertidamente. Ter instruções para executar testes é especialmente útil se exigir configuração externa, como iniciar um servidor Selenium para testes em um navegador.
Mostre seu apreço àqueles que contribuíram para o projeto.
Para projetos de código aberto, informe como ele está licenciado.
Se você ficou sem energia ou tempo para o seu projeto, coloque uma nota no início do README dizendo que o desenvolvimento desacelerou ou parou completamente. Alguém pode optar por bifurcar seu projeto ou se voluntariar como mantenedor ou proprietário, permitindo que seu projeto continue. Você também pode fazer uma solicitação explícita por mantenedores.