File tree 1 file changed +28
-0
lines changed
1 file changed +28
-0
lines changed Original file line number Diff line number Diff line change @@ -129,3 +129,31 @@ the specification supports all the necessary xBOM types along with CDXA.
129
129
130
130
- [ The CycloneDX BOM Exchange API] ( /api/bomexchangeapi.md ) Implemented in the
131
131
[ CycloneDX BOM Repo Server] ( https://github.com/CycloneDX/cyclonedx-bom-repo-server )
132
+
133
+ ## Contributing
134
+
135
+ ### Markdown Formatting
136
+
137
+ This repository uses a Rust-based Markdown formatter (dprint) to ensure
138
+ consistent documentation formatting. When submitting pull requests that include
139
+ Markdown files, the formatter will automatically check for formatting issues.
140
+
141
+ To run the formatter locally:
142
+
143
+ 1 . Install dprint:
144
+ ``` bash
145
+ cargo install dprint
146
+ ```
147
+
148
+ 2 . Check for formatting issues:
149
+ ``` bash
150
+ dprint check " **/*.md"
151
+ ```
152
+
153
+ 3 . Automatically format all Markdown files:
154
+ ``` bash
155
+ dprint fmt " **/*.md"
156
+ ```
157
+
158
+ The formatter enforces a maximum line length of 80 characters and consistent
159
+ formatting across all Markdown files.
You can’t perform that action at this time.
0 commit comments