https://github.com/sap-docs/api-style-guide

Markdown source for the SAP API Style Guide. Enables feedback and contributions to improve the documentation.
https://github.com/sap-docs/api-style-guide

documentation open-documentation-initiative sap source-in-ditacms

Last synced: 8 months ago
JSON representation

Markdown source for the SAP API Style Guide. Enables feedback and contributions to improve the documentation.

• Host: GitHub
• URL: https://github.com/sap-docs/api-style-guide
• Owner: SAP-docs
• License: cc-by-4.0
• Created: 2022-03-07T09:28:53.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-25T09:51:06.000Z (about 2 years ago)
• Last Synced: 2025-01-24T07:25:09.043Z (over 1 year ago)
• Topics: documentation, open-documentation-initiative, sap, source-in-ditacms
• Homepage: https://help.sap.com/products/SNG_4_APIDOC/53e39c8b7c924c28a2575be50bc09786/01e4b09a0bb24235b3618deb0618e1af.html?version=PUBLIC
• Size: 4.24 MB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![REUSE status](https://api.reuse.software/badge/github.com/SAP-docs/api-style-guide)](https://api.reuse.software/info/github.com/SAP-docs/api-style-guide)

# Contributions to SAP API Style Guide

Found a mistake in our documentation? Always wanted to add a step in one of our procedures that could save many others much time? Then you're at the right place! All contributions made to the Markdown files in the [docs](docs) directory are reviewed, and if deemed valuable be added to our [official documentation on SAP Help Portal](https://help.sap.com/products/SNG_4_APIDOC/53e39c8b7c924c28a2575be50bc09786/01e4b09a0bb24235b3618deb0618e1af.html?version=PUBLIC). The easiest way is to start there, and choose _Edit_ to find the right Markdown file to contribute to.

## Requirements

For contributions, it's required that you have a GitHub account. For more information, see [Signing up for a new GitHub account](https://docs.github.com/en/github/getting-started-with-github/signing-up-for-a-new-github-account) in the GitHub documentation.

## Contributing

We recommend using the SAP API Style Guide on SAP Help Portal as a starting point for contributions:

1. Open the [SAP API Style Guide](https://help.sap.com/products/SNG_4_APIDOC/53e39c8b7c924c28a2575be50bc09786/01e4b09a0bb24235b3618deb0618e1af.html?version=PUBLIC).

1. You can either:

    * Choose *Edit* to suggest a change for the current page you see in the Help Portal viewer, or

    * Choose *Feedback* to open a GitHub issue in this repository.

If you only make a small contribution, that's the quickest way to propose a change. For larger contributions, we recommend forking this repository to work locally. The filenames in the [docs](docs) directory are created based on the title of the page on SAP Help Portal.

More information: [Contribution Guidelines](https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/readme.html)

## Code of Conduct

Adhere to the [SAP Open Source Code of Conduct](https://github.com/SAP-docs/.github/blob/main/CODE_OF_CONDUCT.md) to ensure a welcoming and open culture for everyone involved in contributions to SAP documentation.

## Licensing

See our [LICENSE](LICENSE) for copyright and license information.