
Escaneia projetos Java via pom.xml ou build.gradle — correspondência de CVE para dependências Maven/Gradle
Para facilitar o início do seu trabalho com o GitLab, aqui está uma lista de próximos passos recomendados.
Já é experiente? 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/java-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!). Obrigado ao 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 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 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 do projeto estão passando 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ê verá frequentemente 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 ambiguidades e faz com que as pessoas comecem 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 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 rastreador de issues, 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 quem deseja fazer alterações no seu projeto, é útil ter alguma documentação sobre como começar. Talvez haja um script que devam executar ou algumas variáveis de ambiente que precisem definir. Torne estes passos explícitos. Estas instruções também podem ser úteis para o seu eu do futuro.
Também pode documentar comandos para fazer lint ao código ou executar testes. Estes passos ajudam a garantir uma elevada qualidade de código e reduzem a probabilidade de as alterações quebrarem algo inadvertidamente. Ter instruções para executar testes é especialmente útil se for necessário um setup externo, como iniciar um servidor Selenium para testar num navegador.
Mostre o seu apreço por aqueles que contribuíram para o projeto.
Para projetos de código aberto, indique como está licenciado.
Se ficou sem energia ou tempo para o seu projeto, coloque uma nota no topo do README a dizer que o desenvolvimento abrandou ou parou completamente. Alguém pode optar por fazer um fork do seu projeto ou voluntariar-se para assumir como mantenedor ou proprietário, permitindo que o seu projeto continue. Também pode fazer um pedido explícito de mantenedores.
Descubra as ferramentas mais usadas pela nossa comunidade.
Sem dados de popularidade ainda.