[DOCS] showcases, examples & general docs improvements
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par examiner le répertoire examples/ existant et docs/examples.rst, puis vérifiez comment ils sont liés depuis le README et la documentation de l’API. Comme chaque objectif indiqué est vérifié, identifiez d’abord une lacune restante dans les exemples ou la documentation ; le travail est considéré comme terminé lorsqu’un exemple utile d’utilisation complexe est documenté et que les liens concernés ainsi que les attentes de CI restent corrects.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
📣 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
- Langage dominant
- Python
- Étoiles
- 117
- Forks
- 67
- Merge moyen
- 21 h 9 min
- PR mergées (30 j)
- 3
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de CycloneDX/cyclonedx-python-lib
-
[PERF] Quadratic (O(N^2)) serialization time for large BOMs — `Bom.validate()` → `register_dependency()` linear scanPeut-être pris @inspired-geek l’a pris il y a 116 jours. Ouverteperformance
Difficulté 3/5 1-2 jours Accessibilité débutants 36/100
CycloneDX/cyclonedx-python-lib#1006 · 2 commentaires ·
-
tests: test all model enumsPeut-être à nouveau libre @jkowalleck l’a pris il y a 132 jours, et aucune pull request n’est ouverte. OuverteQA
CycloneDX/cyclonedx-python-lib#991 · 1 personne assignée ·
-
feat(deps)!: make all de/serialization libraries optionalPeut-être à nouveau libre @Simoh23999 l’a pris il y a 80 jours, et aucune pull request n’est ouverte. Ouvertebreaking change dependencies
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
CycloneDX/cyclonedx-python-lib#979 · 2 commentaires ·
-
feat: Add support for Component signaturePeut-être pris @wiebe-vandendriessche l’a pris il y a 131 jours. Ouverteenhancement help wanted schema 1.4
Difficulté 3/5 1-2 jours Accessibilité débutants 58/100
CycloneDX/cyclonedx-python-lib#978 · 4 commentaires ·
-
chore: have coverage uploaded consitentlyPeut-être à nouveau libre @jkowalleck l’a pris il y a 178 jours, et aucune pull request n’est ouverte. Ouvertechore
CycloneDX/cyclonedx-python-lib#966 · 1 personne assignée ·
Toutes les issues de CycloneDX/cyclonedx-python-lib
Issues similaires
-
Examples say cnxOuvertedocumentation embedded
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
Alishahryar1/free-claude-code#2111 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
namespace operations
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
EclipseFdn/open-vsx.org#14373 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 1 jour