Skip to content
This repository has been archived by the owner on Sep 13, 2023. It is now read-only.

Latest commit

 

History

History
74 lines (56 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

74 lines (56 loc) · 2.8 KB
Raw

Contributing

How Do I Contribute a Showcase?

On the Contribute a Showcase page, follow the steps of the showcase wizard and download the resulting zip file.

Submitting a Pull Request

Extract the downloaded zip file and complete the following steps:

  1. Fork the ui5-showcases GitHub repository.

  2. Add the images from the extracted large folder to:

    <your_fork>/showcaselib/src/showcaselib/shared/data/large

  3. Add the images from the extracted small folder to:

    <your_fork>/showcaselib/src/showcaselib/shared/data/small

  4. Copy and paste the contents from the extracted myShowcase.json file into the following file:

    <your_fork>/showcaselib/src/showcaseslib/shared/data/model/showcases.json

  5. In your fork, create a pull request to the master branch of the original repository.

  6. Sit back and wait until your pull request is approved.

How Do I Contribute to the Showcase Application?

Requirements

You need to have the following tools installed:

Installation

  1. Fork this repository.
  2. Clone the forked repository to your local machine.
  3. In the showcaseslib/ directory, install the dependencies for the showcases library: 
    cd showcaseslib/
npm install
  4. In the application/ directory, install the application dependencies: 
    cd ../application
npm install
  5. Start the application (in the application/ folder) 
    npm start
  6. Open http://localhost:8080

Make Your Changes

  1. Make sure the master branch of your fork is up to date by syncing your fork.
  2. Create a new feature branch from the latest master:
    • Run git checkout -b the-feature-name.
  3. Make your changes, and save your files.
  4. Commit and push your changes to the forked repository:
    • To commit, run git add -A && git commit -m "Meaningful commit message"
    • To push, run git push

Create a Pull Request

Create a pull request from the feature branch of the forked repository to the master branch of the original repository.

We will review your changes and get back to you.

Developer Certificate of Origin (DCO)

Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.