[DOCS] showcases, examples & general docs improvements
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando la directory examples/ esistente e docs/examples.rst, quindi verifica come sono collegati dal README e dalla documentazione dell’API. Poiché ogni obiettivo elencato viene verificato, individua innanzitutto una lacuna ancora presente negli esempi o nella documentazione; il lavoro è completo quando viene documentato un esempio utile di utilizzo complesso e i link pertinenti e le aspettative di CI rimangono corretti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
📣 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
- Lingua principale
- Python
- Stelle
- 117
- Fork
- 67
- Merge medio
- 21h 9m
- PR unite (30g)
- 3
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di CycloneDX/cyclonedx-python-lib
-
[PERF] Quadratic (O(N^2)) serialization time for large BOMs — `Bom.validate()` → `register_dependency()` linear scanForse già presa @inspired-geek l’ha presa 108 giorni fa. Apertaperformance
Difficoltà 3/5 1-2 giorni Idoneità per principianti 36/100
CycloneDX/cyclonedx-python-lib#1006 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
tests: test all model enumsForse di nuovo libera @jkowalleck l’ha presa 124 giorni fa e non c’è nessuna pull request aperta. ApertaQA
CycloneDX/cyclonedx-python-lib#991 · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
feat(deps)!: make all de/serialization libraries optionalForse di nuovo libera @Simoh23999 l’ha presa 72 giorni fa e non c’è nessuna pull request aperta. Apertabreaking change dependencies
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
CycloneDX/cyclonedx-python-lib#979 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
feat: Add support for Component signatureForse già presa @wiebe-vandendriessche l’ha presa 123 giorni fa. Apertaenhancement help wanted schema 1.4
Difficoltà 3/5 1-2 giorni Idoneità per principianti 58/100
CycloneDX/cyclonedx-python-lib#978 · 4 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
chore: have coverage uploaded consitentlyForse di nuovo libera @jkowalleck l’ha presa 170 giorni fa e non c’è nessuna pull request aperta. Apertachore
CycloneDX/cyclonedx-python-lib#966 · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di CycloneDX/cyclonedx-python-lib
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
awslabs/visual-asset-management-system#414 ·
I maintainer di solito rispondono entro 1 giorno
-
bug v1 v2
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
modelcontextprotocol/python-sdk#3670 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
aicell-lab/bioengine#232 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
modelscope/evalscope#1836 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100