Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 4.33 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 4.33 KB
Raw

Contributing to UI5 Web Components

📖 Content

💻 Contributing Code

General Remarks

You are welcome to contribute code to the UI5 Web Components in order to fix bugs or to implement new features.

There are three important things to know:

  1. You must be aware of the Apache License (which describes contributions) and agree to the Contributors License Agreement. This is common practice in major Open Source projects. To make this process as simple as possible, we are using CLA assistant for individual contributions. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click experience for accepting the CLA. For company contributors, special rules apply. See the respective section below for details.
  2. Follow our Development Conventions and Guidelines.
  3. Not all proposed contributions can be accepted. Some features may just fit a third-party add-on better. The code must match the overall direction of the UI5 Web Components and improve it. So there should be some "bang for the byte". For most bug fixes this is a given, but a major feature implementation first needs to be discussed with one of the committers. Possibly, one who touched the related code or module recently. The more effort you invest, the better you should clarify in advance whether the contribution will match the project's direction. The best way would be to just open an enhancement ticket in the issue tracker to discuss the feature you plan to implement (make it clear that you intend to contribute). We will then forward the proposal to the respective code owner. This avoids disappointment.

Contributor License Agreement

When you contribute code, documentation, or anything else, you have to be aware that your contribution is covered by the same Apache 2.0 License that is applied to the UI5 Build and Development Tooling itself.

In particular, you need to agree to the Individual Contributor License Agreement, which can be found here. This applies to all contributors, including those contributing on behalf of a company.

If you agree to its content, you simply have to click on the link posted by the CLA assistant as a comment in the pull request. Click it to check the CLA, then accept it on the following screen if you agree to it. The CLA assistant saves this decision for upcoming contributions to that repository and notifies you, if there is any change to the CLA in the meantime.

Company Contributors

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

A company representative authorized to do so needs to download, fill in, and print the Corporate Contributor License Agreement form and then proceed with one of the following options:

  • Scan and e-mail it to [email protected] and [email protected]
  • 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

The form contains a list of employees who are authorized to contribute on behalf of your company. When this list changes, please let us know.

How to Contribute

  1. Make sure the change is welcome (see General Remarks).
  2. Create a branch by forking the relevant UI5 Web Components repository and apply your change.
  3. Commit and push your change on that branch.
  4. Create a pull request in the UI5 Web Components repository.
  5. Follow the link posted by the CLA assistant to your pull request and accept it, as described above.
  6. Wait for our code review and approval, possibly enhancing your change on request.
    • Note that the UI5 Web Components developers have many duties. So, depending on the required effort for reviewing, testing, and clarification, this may take a while.
  7. Once the change has been approved and merged, we will inform you in a comment.
  8. Celebrate!