Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (34 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

60 lines (34 loc) · 3.54 KB

Contributing to an SAP Open Source Project

Code of Conduct

All members of the project community must abide by the SAP Open Source Code of Conduct. Only by respecting each other can we develop a productive, collaborative community. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by creating a GitHub issue.

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.

Contributing with AI-generated code

  • If you are a new contributor, see: Steps to Contribute

  • Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue.

  • The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation.

Steps to Contribute

Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue.

If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify.

Contributing Code or Documentation

You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue.

The following rule governs code contributions:

  • Contributions must be licensed under the Apache 2.0 License
  • Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.

Generated Artifacts and Review Process

This repository checks in certain generated files (TypeScript types and UMS types). We intentionally commit these artifacts so pull requests clearly show the impact on those interfaces and downstream consumers during review.

  • What is generated: TypeScript interfaces referenced unde dist/generated/spec/v1 and src/generated and UMS types referenced under spec/v1 and src/generated/.
  • How to generate: run npm run generate (this executes the spec toolkit and copies results via the postgenerate step).

CI verification

To prevent accidental divergence, our CI runs npm run generate and fails if it produces changes that are not committed. This protects the main branch from merging updates that forgot to regenerate.

Local pre-commit hook (optional)

We provide a pre-commit hook via Lefthook that automatically runs npm run generate before each commit and re-stages any changed files. This helps ensure generated artifacts are always included.

Enable it locally:

npm i -D lefthook
npx lefthook install

Issues and Planning

  • We use GitHub issues to track bugs and enhancement requests.

  • Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee.