CONTRIBUTING.md

Contributing

When contributing to this repository, please consider the following aspects

Adding a new Container component

Container components implement the communication with Redux to obtain the available telemetry/event data. Container components:

1. Should be named component.container.jsx
2. Should include and export a schema variable with the UIF configuration
3. Should provide a subscriptions prop with the telemetry/event subscription list, to be displayed in the telemetry/event raw data. Also, the component.container.jsx render method must include:

if (props.isRaw) {
    return <SubscriptionTableContainer subscriptions={props.subscriptions}></SubscriptionTableContainer>;
}

Editing the documentation

The documentation is done with styleguide. Its source code is located under love/docsrc and compiled to docs/ according to the configuration file located at love/styleguide.config.js.

1. To edit the docs in a local server run

docker-compose exec frontend 
# inside frontend container
yarn guide:start

and go to the pointed address.

2. To create a production build in the docs/ folder run

docker-compose exec frontend
# inside frontend container
yarn guide:build

3. Some useful guides to edit the configuration:

• General configuration

  • Create a new section:
  • Show 1 page per section or 1 page with all sections
  • Changing the build dir

• Documenting the source code

  • Adding .md files for examples, using jsDocs for descriptions, proptypes and defaultprops.
  • Documenting with redux
  • Adding static assets