Skip to content
This repository has been archived by the owner on Jun 13, 2022. It is now read-only.

Latest commit

 

History

History
65 lines (39 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

65 lines (39 loc) · 2.74 KB

Contributing to i40-aas

You want to contribute to i40-aas? Welcome! Please read this document to understand what you can do:

Analyze Issues

Analyzing issue reports can be a lot of effort. Any help is welcome! Go to the Github issue tracker and find an open issue which needs additional work or a bugfix. Maybe you can even find and contribute a bugfix?

Issue Handling Process

When an issue is reported, a committer will look at it and either confirm it as a real issue (by giving the "approved" label), close it if it is not an issue, or ask for more details. Approved issues are then either assigned to a committer in GitHub, reported in our internal issue handling system, or left open as "contribution welcome" for easy or not urgent fixes. An issue that is about a real bug is closed as soon as the fix is committed.

Contribute Code

You are welcome to contribute code to i40-aas in order to fix bugs or to implement new features.

We are using editorconfig in combination with eclint to format our src files. If you want to contribute code, please install an editorconfig.org plugin for your IDE or run eclint fix for all of your changed files.

install the clt

npm i eclint -g

navigate to the root folder of i40-aas

cd <path to projects root folder>

check that you only format your files

eclint check '<path to your changed files>'

//e.g. eclint check 'src/ts/cmd/onboarding-skill/**/*.ts'


fix your changed files

eclint fix '<path to your file>'

// e.g. eclint fix 'src/ts/cmd/onboarding-skill/src/server.ts' for a specific src file
// or eclint fix 'src/ts/cmd/onboarding-skill/**/*.ts' for all src files in this folder

Reporting Security Issues

If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited.

Developer Certificate of Origin (DCO)

Due to legal reasons, contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.