Skip to content

Contributing

Contributor License Agreement

There are two versions of the Contributor License Agreement (CLA). The contributor should be able to chose the right one:

The CLA is drafted for re-use for any contributions the (same) contributor makes, so that it needs to be signed only once. This CLA does not enable Siemens Healthineers to use or process personal data. The contributor must not contribute personal data according to this CLA.

Contributing with code

The code is mainly written in Go and PowerShell. See PowerShell Development for more information.

The codebase structure looks like the following:

├── addons      --> Addon(s)-specific configuration and PowerShell scripts
├── bin         --> Binaries (either committed to this repo or dropped as build target)
├── build
├── cfg         --> Configuration files
├── docs        --> Main documentation
├── k2s         --> Go-based sources
├── lib         --> PowerShell scripts
├── LICENSES
├── smallsetup  --> [legacy] PowerShell scripts; to be migrated to "lib"
├── test        --> Main test script(s)
├── ...
├── README.md
├── k2s.exe
├── VERSION
└── ...
  1. Clone the Git Repository
  2. Make your changes locally, adhering to the Licensing Obligations
  3. Build Locally
  4. Create Automated Tests and execute them successfully
  5. Update the Documentation
  6. Submit your Changes