Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 3.36 KB
Raw

Overview

Thank you for your interest in contributing to our project! It's people like you that make the open source community such a great community! 😊

We welcome any type of contribution, not only code. You can help and

  • analyze issues: take a look at the open issues. Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
  • report an issue: do not hesitate to file a new issue. The more details you can give the better
  • provide feedback: is the README insufficient or the API documentation unclear? Let us know!

Submitting code and pull request handling

All contributions are handled via Pull Requests (PRs). We are currently busy finalizing our open-source milestone release so your PR must target the master branch.

Quick checklist summary before submitting a PR:

  • 🔎 Make sure tests are added or updated to accommodate your changes. When possible, add tests to verify bug fixes and prevent future regressions.
  • 👌 Verify that tests pass and code is free of SwiftLint violations
  • 📖 Check that your commit message follows Conventional Commit standards and has a meaningful description of what it is about
  • 👍 Push it!

We reserve the right to close or to not process pull requests.

We recommend to run setupForCollaborators.sh in root directory once to install helpful tools. For example, the script will

  • install various git hooks
    • to run a SwiftLint check automatically before pushing your sources to remote
    • to help creating a commit messages according to the Conventional Commits standards, just use git commit command
  • install Xcode project file and adds a run script to ensure that SwiftLint checks are getting executed when you are working within XCode

If you choose to run the script please make sure your dev machine has

  • python 3.7+ (includes pip as package manager)
    • tip: you can use pyenv to manage and switch between multiple python versions
  • npm (with npx as package runner which is included with 5.2+)

Legal stuff

Contributors License Agreement

We require you to agree and sign a Contributors License Agreement for code contribution.

Sign your CLA here. You only have to do it once 😊

This is common practice in all major Open Source projects.

Company Contributors

If employees of a company contribute code, in addition to the individual agreement above, there needs to be one company agreement submitted. This is mainly for the protection of the contributing employees.

A company representative authorized to do so needs to download, fill, and print the Corporate Contributor License Agreement form. Then either:

  • Scan it and e-mail it to opensource@sap.com and cloud-sdk-ios-fiori@sap.com
  • Fax it to: +49 6227 78-45813
  • Send it by traditional letter to: Industry Standards & Open Source Team, Dietmar-Hopp-Allee 16, 69190 Walldorf, Germany