You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-2Lines changed: 30 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ product related artefacts, like BOMs, between systems. The work includes:
26
26
- Querying
27
27
28
28
System and tooling implementors are encouraged to adopt this API standard for
29
-
sending/receiving transparency artefacts between systems.
29
+
sending/receiving transparency artefacts between systems.
30
30
This will enable more widespread
31
31
"out of the box" integration support in the BOM ecosystem.
32
32
@@ -49,7 +49,7 @@ The Transparency Exchange API (TEA) supports publication and retrieval of a set
49
49
50
50
### xBOM
51
51
52
-
Bill of materials for any type of component and service are supported. This includes, but is not limited to, SBOM, HBOM, AI/ML-BOM, SaaSBOM, and CBOM. The API provides a BOM format agnostic way of publishing, searching, and retrieval of xBOM artifacts.
52
+
Bill of materials for any type of component and service are supported. This includes, but is not limited to, SBOM, HBOM, AI/ML-BOM, SaaSBOM, and CBOM. The API provides a BOM format agnostic way of publishing, searching, and retrieval of xBOM artifacts.
53
53
54
54
### CDXA
55
55
@@ -90,6 +90,34 @@ Insights allows for “limited transparency” that can be asked and answered us
90
90
91
91

92
92
93
+
## Contributing
94
+
95
+
### Markdown Formatting
96
+
97
+
This repository uses a Rust-based Markdown formatter (dprint) to ensure
98
+
consistent documentation formatting. When submitting pull requests that include
99
+
Markdown files, the formatter will automatically check for formatting issues.
100
+
101
+
To run the formatter locally:
102
+
103
+
1. Install dprint:
104
+
```bash
105
+
cargo install dprint
106
+
```
107
+
108
+
2. Check for formatting issues:
109
+
```bash
110
+
dprint check "**/*.md"
111
+
```
112
+
113
+
3. Automatically format all Markdown files:
114
+
```bash
115
+
dprint fmt "**/*.md"
116
+
```
117
+
118
+
The formatter enforces a maximum line length of 80 characters and consistent
0 commit comments