Skip to content

Latest commit

 

History

History
126 lines (90 loc) · 10.6 KB

CONTRIBUTING.md

File metadata and controls

126 lines (90 loc) · 10.6 KB
Raw

Contributing

We welcome and ❤ contribution in all forms: create issues, opening pull requests to make elements even better, or just being part of our development community.

Create Issues

Issues are important to make the Element Framework better. If you discover any issues with this project, please feel free to create an Issue. Please search through open and closed issues to see if a similar issue already exists. If not, open an issue and try to provide a minimal reproduction if you can.

Pull Requests

In the event you have coding suggestions and you would like to create pull request to this repository, it is required that you read and sign the following:

  • Individual Contributor License Agreement (Download)
  • Entity Contributor License Agreement (Download)

Please email a signed and scanned copy to [email protected]. If you require that a signed agreement has to be physically mailed to us, please email the request for a mailing address and we will get back to you on where you can send the signed documents.

We will review issues and pull requests to determine any appropriate changes.

Developing

Element Framework is using monorepo. This repository has elements, supporting modules and tools. Each folder in packages is one NPM package.

  • packages/configurations - Configuration file for element development e.g. eslint, typescript
  • packages/core - Core module of element e.g. base classes, element registration
  • packages/create-efx - Initializer for creating a new EFX elements
  • packages/demo-block - Use in demo page of each element to demonstrate element's features
  • packages/elemental-theme - Base theme to extend to design system theme e.g. Halo Theme
  • packages/elements - All elements in Element Framework
  • packages/halo-theme - LSEG Workspace design system theme
  • packages/i18n - Wrappers and APIs of formatjs
  • packages/phrasebook - All messages (english and non-english) that use within elements
  • packages/solar-theme - Legacy theme
  • packages/test-helpers - Helpers function for unit testing of each elements
  • packages/theme-compiler - LESS compiler for generating theme package
  • packages/translate - Decorator for translations (i18n) in each element
  • packages/utils - Utilities and shared functions

Setup development environment

Install npm@7 CLI:

npm install -g npm

Initialize project:

git clone [email protected]:Refinitiv/refinitiv-ui.git
cd refinitiv-ui
npm install

Build all packages:

npm run build

CLI Commands

The command-line interface tool that you can use to demo, develop, test, and maintain this repository. The command should be run at root level.

Run and serve the element or package:

npm run start button
#or
npm run start demo-block

Run the unit test in specific element or package:

npm run test button -- <options>

Run the unit test on all packages:

add options --parallel=1 to prevent port crash on local

npm run test:all --parallel=1

Run linting tools in specific a element or package:

npm run lint button -- <options>
#or
npm run lint demo-block -- <options>

Run linting tools in all elements or packages:

npm run lint:all

Options for unit test and linting command

Option Description
--browsers or -b You can specific browser(s) to run the unit test. List of available browsers are following: chrome, firefox and ie
You can check the list of available browsers by add option --help.
Usage: npm run test button -- --browsers chrome firefox
--browserstack or --bs You can run test on BrowserStack with specific browser(s). List of available browsers are following: chrome, firefox, edge_previous, and aliases default, supported, and etc.
This command option required BrowserStack API Key you must setting the three environment variables BROWSERSTACK_USERNAME, BROWSERSTACK_ACCESS_KEY, and BROWSERSTACK_BUILD(specify a name for a logical group of tests, set your name if run command on local machine). You can create API key from here
Usage: npm run test button -- --browserstack chrome firefox_previous
--watch or -w Run test and watch file change.
Usage: npm run test button -- --watch
--update-snapshots or -s Update and prune snapshots (--browsers must be chrome).
Usage:npm run test button -- --update-snapshots --browsers chrome
--fix or -f Run linting and fix the issues that can lead to bugs or inconsistencies with code health and style.
Usage:npm run lint button -- --fix

Commit prefixes

Commit prefixes must be written in a correct pattern when committing code into EF repositories. It will be used to determine running version when release the package and for generating changelogs.

Prefix Incremental Version Usage
BREAKING CHANGE(<package-name>): MAJOR Changes that breaking existing public API.
BREAKING CHANGE(coral-button): cta attribute has been removed
feat(<package-name>): MINOR A new feature.
feat(coral-button): element sings a song every Sunday
fix(<package-name>): PATCH A bug fix.
fix(coral-button): auto-play issue (#39)
style(<package-name>): PATCH Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
style(coral-button): removed trailing white space
docs(<package-name>): PATCH Documentation only changes.
docs(coral-button): included complex sample to README
refactor(<package-name>): PATCH A code change that neither fixes a bug nor adds a feature.
refactor(coral-button): changed song picker algorithm
performance(<package-name>): PATCH A code change that improves performance.
performance(coral-button): lazy load internal DOM structure
test(<package-name>): PATCH Add missing tests.
test(coral-button): increase code coverage to 85%
chore(<package-name>): PATCH Changes to the build process, dependency updates and other maintenance-related commits.
chore(coral-button): upgrade dependencies