[DOCS] showcases, examples & general docs improvements
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Comece revisando o diretório examples/ existente e docs/examples.rst e, em seguida, verifique como eles estão vinculados a partir do README e da documentação da API. Como todos os objetivos listados são verificados, primeiro identifique uma lacuna restante nos exemplos ou na documentação; considera-se concluído quando um exemplo útil de uso complexo é documentado e os links relevantes e as expectativas de CI permanecem corretos.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
📣 THIS IS A CALL FOR DOCS
Feel free to add pull requests with examples here:
- https://github.com/CycloneDX/cyclonedx-python-lib/tree/main/examples
- https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/docs/examples.rst
There are currently no (complex) examples how to use this lib.
Yes, there are API docs, and small snippets, but no examples.
Even the unit tests do now showcase example usage, as they are much declarative or not expressive enough.
GOAL:
- have examples in a
examplesfolder - link the examples in the README
- link the examples in the (api)-docs
- prevent
examplesdir from being shipped (sdist/bdist) - have examples run in CI
- Linguagem predominante
- Python
- Estrelas
- 117
- Forks
- 67
- Merge médio
- 8min
- PRs com merge (30d)
- 1
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de CycloneDX/cyclonedx-python-lib
-
[PERF] Quadratic (O(N^2)) serialization time for large BOMs — `Bom.validate()` → `register_dependency()` linear scanTalvez já em andamento @inspired-geek assumiu há 119 dias. Abertaperformance
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 36/100
CycloneDX/cyclonedx-python-lib#1006 · 2 comentários ·
-
tests: test all model enumsTalvez livre de novo @jkowalleck assumiu há 134 dias e não há nenhum pull request aberto. AbertaQA
CycloneDX/cyclonedx-python-lib#991 · 1 responsável ·
-
feat(deps)!: make all de/serialization libraries optionalTalvez livre de novo @Simoh23999 assumiu há 82 dias e não há nenhum pull request aberto. Abertabreaking change dependencies
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
CycloneDX/cyclonedx-python-lib#979 · 2 comentários ·
-
feat: Add support for Component signatureTalvez já em andamento @wiebe-vandendriessche assumiu há 133 dias. Abertaenhancement help wanted schema 1.4
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 58/100
CycloneDX/cyclonedx-python-lib#978 · 4 comentários ·
-
chore: have coverage uploaded consitentlyTalvez livre de novo @jkowalleck assumiu há 181 dias e não há nenhum pull request aberto. Abertachore
CycloneDX/cyclonedx-python-lib#966 · 1 responsável ·
Todas as issues de CycloneDX/cyclonedx-python-lib
Issues semelhantes
-
[Bug]: `hermes plugins update` clones an entire monorepo twice - `subdir` is resolved but dropped at both catalog-update call sitesTalvez já em andamento @HootRock assumiu hoje. Abertacomp/cli P2 type/perf
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
NousResearch/hermes-agent#142417 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
bug enhancement python
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
DewaldOosthuizen/tech-cheat-sheets-and-notes#392 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
Mantenedores costumam responder em até 1 dia
-
bug p2
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
amd/gaia#5471 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Restore postgresql_vm_test_charm actions.yaml change (removed in canonical/postgresql-operator#2054)Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
canonical/postgresql-single-kernel-library#390 · 1 comentário ·
Mantenedores costumam responder em até 2 dias