Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[2.0] docs - streamline code, literals, in-text examples, referenced properties

Open
#1,085 0 comments 0 reactions 1 assignee View on GitHub

@jkowalleck is already working on this.

Since Sep 7, 2026.

  • #1084 by @jkowalleck — open

Assessment

This issue has not been assessed yet.

Description

CDX 2.0 documentation

in the CycloneDX 2.0 documentationals description, $comment, meta:enum there are string literals, references to properties, and other "special elements" used, that shall be given some semantics - and they need streamlining.

in the JSON files, search for regex:

\\"|'|`

examples

goal:

  • Referred fields are markdown code blocks -- start and stop with a "`"
  • string literal values are marked as such by using double quotes -- like "some_value"
  • if a value refers to a property, then the code blocks hall make this clear -- myField="some_value" or myOther=false

example fixes:

- "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types.", 
+ "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component with `type=\"machine-learning-model\"` and must not be specified for other component types.", 
- "description": "For an activity node, the behavior performed, drawn from the taxonomy. Mutually exclusive with 'ref' and 'graph'." 
+ "description": "For an activity node, the behavior performed, drawn from the taxonomy. Mutually exclusive with `ref` and `graph`." 
Dominant language
XSLT
Stars
551
Forks
93
Avg merge
4h 51m
Merged PRs (30d)
42

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CycloneDX/specification

All issues in CycloneDX/specification

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.