Contributing to Ignite UI Help samples

Overview

To contribute to the list of Ignite UI Help samples you can follow these steps:

1. Fork or clone the repository
2. Perform the changes in your local repository
3. Verify your changes and push them
4. Create a pull request according to the Workflow

Build samples

To build the samples locally, first install the required modules by running:

npm install

Once the setup is complete the build command can be run:

gulp build-samples --version 16.2

Available parameters:

• --version: The version of the samples. This should generally match the branch name, but will fall back to "latest" if not set.
• --ignite-ui: Optional. Root URL for the Ignite UI source. Defaults to the CDN location.
• --live-url: Optional. Root URL for the live samples location.

Results

After the above command completes successfully the produced samples will be available under the ./dist/<version>/<lang> folder, where under the built version both EN and JA folders with localized samples will be present. Samples are placed in their own folders under a control one and the resulting index.html should be directly runnable.

Next to the sample in a ./fiddle folder will be broken down snippets of the HTML, JS and optionally CSS parts. Those should contain everything needed to piece the sample back together or run in playground tools like JSFiddle.

Workflow

When you create a Pull Request with your proposed changes reference the related issue if applicable. A review will be required before it is merged and you can assign a reviewer as well.

Versions

If the change made is to be applied to an existing version (e.g. 16.2) create the pull request targeting that branch. That change should also be merged up back to master.

Localization - applicable to pull requests

If your change requires new localization strings or has changed existing ones use the following labels:

1. status: pending-localization this status tells that there are changes in the localization strings that need to be translated. When you make such changes, put this status badge without removing the other applicable ones and assign a person to do the translations.
2. status: localized this status is for issues that were with a pending translation status and have already been localized. Place this status label once these translation changes have been included in the current pull request, or the changes are already pulled with a different pull request.