Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 2.79 KB

Guidance On How To Contribute

There are two primary ways to help:

Using the issue tracker

Use the issue tracker to suggest feature requests, report bugs or ask questions. This is also a great way to connect with the developers of the project as well as others who are interested in this tool.

Changing the code

Use the issue tracker to find ways to contribute. Find a bug or a feature, mentioned in the issue that you will take care of.

Technically, you fork this repository, make changes in your own fork, and then submit a pull-request. All new code should have been thoroughly tested end-to-end in order to validate implemented features and the presence or lack of defects.

Working with forks

before beginning to work on a new pull-request.

Contributing with AI-generated code

As artificial intelligence evolves, AI-generated code is becoming valuable for many software projects, including open-source initiatives. While we recognize the potential benefits of incorporating AI-generated content into our open-source projects there a certain requirements that need to be reflected and adhered to when making contributions.

Please see our guideline for AI-generated code contributions to SAP Open Source Software Projects for these requirements.

Tests

All coding must come with automated go unit tests.

Documentation

New or changed functionality needs to be documented, so it can be properly used. Implementation of a functionality and its documentation shall happen within the same commit(s) and/or pull-request.

Code Style

Formatting

You must run go fmt on your changes to ensure proper code formatting before you open a pull-request

Linting

You must run golint and solve all warnings before you open a pull-request

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.