SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 05:40:11 +01:00
Code Issues Releases Activity Actions

Docs: Add Development.md (#493)

Browse source 
* Add docs/Development.md

* Fix link
This commit is contained in:
Sascha L. Teichmann 2023-11-02 13:06:37 +01:00 • committed by GitHub
parent 03a907b9b8
commit 7fbc012e2c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/Development.md Normal file
View file

@ -0,0 +1,18 @@
# Development
## Generated files
Some source code files are machine generated. At the moment these are only
[cvss20enums.go](../csaf/cvss20enums.go) and [cvss3enums.go](../csaf/cvss3enums.go) on the
basis of the [Advisory JSON schema](../csaf/schema/csaf_json_schema.json).
If you change the source files please regenerate the generated files
with `go generate ./...` in the root folder and add the updated files
to the version control.
If you plan to add further machine generated files ensure that they
are marked with comments like
```
// THIS FILE IS MACHINE GENERATED. EDIT WITH CARE!
```
.