Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

[DOCS]: Add an Example of Validating SBOMs

Ouverte
#708 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

  • #5 par @saquibsaifee — fermée sans fusion
  • #869 par @saquibsaifee — fermée sans fusion

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
documentation

Piste de recherche

Commencez par localiser la documentation existante ainsi que JsonStrictValidator et les classes de validation associées dans la bibliothèque Python. Ajoutez une vue d’ensemble de la validation des SBOM basée sur un schéma et des exemples de code, y compris une validation indépendante de la sérialisation. Le travail est terminé lorsque les utilisateurs peuvent suivre la documentation pour valider un SBOM à l’aide des classes pertinentes.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation help wanted

Create documentation to guide users on validating SBOMs.

The CycloneDX Python library can validate an SBOM based on the schema, independent of the library's support for SBOM serialization, which is a valuable feature. However, the current documentation lacks clear examples and instructions on effectively utilizing this validation functionality.

The following points should be addressed in the documentation:

An overview of how to validate SBOMs based on schema specifications.
Examples demonstrating the validation process, including code snippets using JsonStrictValidator and other relevant classes.

Langage dominant
Python
Étoiles
117
Forks
67
Merge moyen
21 h 9 min
PR mergées (30 j)
3

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de CycloneDX/cyclonedx-python-lib

Toutes les issues de CycloneDX/cyclonedx-python-lib

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.