
Escaneia aplicações Ruby/Rails via Gemfile.lock — compara gems com o banco de dados de CVEs do ValtersIT
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 torná-lo seu. Quer facilitar? Use o modelo na parte inferior!
cd existing_repo
git remote add origin https://gitlab.com/valtersit/ruby-cve-scanner.git
git branch -M main
git push -uf origin main
Use a integração contínua integrada no GitLab.
Quando estiver pronto para tornar este README seu, basta editar este arquivo e usar o modelo prático abaixo (ou sinta-se à vontade para estruturá-lo como quiser - este é apenas um ponto de partida!). Agradecimentos a makeareadme.com por este modelo.
Cada projeto é diferente, então 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. Também tenha em mente que, embora um README possa ser longo e detalhado demais, longo demais é melhor do que curto demais. Se você acha que seu README está longo demais, considere utilizar outra forma de documentação em vez de cortar informações.
Escolha um nome autoexplicativo para seu projeto.
Deixe as pessoas saberem o que seu projeto pode fazer especificamente. Forneça contexto e adicione um link para qualquer referência com a qual os visitantes possam não estar familiarizados. 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 diferenciadores.
Em alguns READMEs, você pode ver pequenas imagens que transmitem metadados, como se todos os testes estão passando para o projeto ou não. 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ê frequentemente verá GIFs em vez de vídeos reais). Ferramentas como ttygif podem ajudar, mas confira o 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 gostaria de mais orientação. Listar etapas específicas ajuda a remover ambiguidade e leva as pessoas a usar seu projeto o mais rápido possível. Se ele só funciona em um contexto específico, como uma versão específica de linguagem de programação ou sistema operacional, ou tem dependências que precisam ser instaladas manualmente, adicione também uma subseção de Requisitos.
Use exemplos liberalmente e mostre a saída esperada se puder. É útil ter inline o menor exemplo de uso que você pode demonstrar, enquanto fornece links para exemplos mais sofisticados se eles forem longos demais para serem incluídos razoavelmente no README.
Diga às pessoas onde elas podem ir para obter ajuda. Pode ser qualquer combinação de um issue tracker, uma sala de chat, um endereço de e-mail, etc.
Se você tem ideias para lançamentos futuros, é uma boa ideia listá-las no README.
Declare 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 definir. Torne esses passos explícitos. Estas instruções também podem ser úteis para o seu eu do futuro.
Você também pode documentar comandos para lint do código ou execução de testes. Esses passos 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 isso exigir configuração externa, como iniciar um servidor Selenium para testes em um navegador.
Demonstre seu apreço àqueles que contribuíram para o projeto.
Para projetos de código aberto, informe como ele é licenciado.
Se você ficou sem energia ou tempo para o seu projeto, coloque uma nota no topo do README dizendo que o desenvolvimento desacelerou ou parou completamente. Alguém pode optar por fazer um fork do seu projeto ou se voluntariar para assumir como mantenedor ou proprietário, permitindo que seu projeto continue. Você também pode fazer uma solicitação explícita por mantenedores.
Descubra as ferramentas mais usadas pela nossa comunidade.
Sem dados de popularidade ainda.