Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

71 lines (51 loc) · 2.72 KB

Contributing

When contributing to this repository, please consider the following aspects

Making a release (creating a tag)

In order to make a release of the frontend, you need to create a tag in the repository. The tag should be named vX.Y.Z where X.Y.Z is the version number. The version number should follow semantic versioning. The tag should be created from the master branch.

Before creating the tag, make sure to:

  • Create a PR that updates the love/package.json file with the new version number X.Y.Z.
  • Check the CHANGELOG.md file is updated with the changes that are going to be released.

Once the PR is merged, create the tag with the following command:

git checkout develop
git pull
git checkout main
git pull
git merge --no-ff develop
git tag -a vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.Z

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.

  1. To create a production build in the docs/ folder run
docker-compose exec frontend
# inside frontend container
yarn guide:build
  1. Some useful guides to edit the configuration: