Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 2.8 KB
Raw

Contributing

Contributions to the SAP Vocabularies are highly welcome. These contributions could be

  • Corrections and improvements to existing terms
  • Examples for using an existing term
  • New properties in an existing structured term
  • New terms in an existing vocabulary
  • New vocabularies (well, this is probably rare :-)

We prefer pull requests over issues, so

  • If you find a typo in a term description, please create a pull request that corrects the typo
  • If a term description is confusing, please create a pull request and provide a description that you find helpful
  • If you wonder how to apply a term, please create a pull request with a usage example
  • If you want to extend a term, please create a pull request with the new definition and a usage example
  • If you want to propose new terms or vocabularies, please first check whether this should be an SAP term or vocabulary, or whether it is more generic and belongs to an OASIS OData Vocabulary, then create a pull request in the corresponding repository

Issues

Please report bugs in English, so all users can understand them.

And please create a pull request with a proposed fix to the bug instead of an issue.

Pull Requests

Keep changes to a minimum, e.g. preserve line ends, indentation, line breaks etc.

Provide a usage example for proposed terms and term properties.

The XML files are the source of truth, don't edit the JSON or Markdown files! Direct edits to the JSON or Markdown files will be lost after the next build. See README - Download and Installation.

Execute npm run build before committing a change, so that the JSON and Markdown files are in sync with the edited XML files. This will be done automatically via a GitHub Action for pull requests in this repository. If you are working in a fork, please go to the "Actions" tab of your fork and enable actions.

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.

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 are 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.