Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 2.86 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 accept the Developer Certificate of Origin. 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.

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.

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!