OpenLightingProject / OpenLightingProject/open-fixture-library

Import functionality in fixture editor

Open
#565 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component-editor component-plugin difficulty-medium
Dominant language
JSON
Stars
258
Forks
100
Avg merge
11h 52m
Merged PRs (30d)
53

Description

For some of our plugins, we've already implemented an import method to create OFL fixtures out of a given foreign fixture file. This functionality is still only accessible via a CLI tool; there should be an easy tool in the public UI for this!

Possible workflow for an end-user:

  1. Go to the import page.
  2. Select a plugin.
  3. Upload a fixture file (maybe also more than one; some plugins need several files to represent a single fixture)
  4. Show which fixtures could be imported (maybe allow merging fixtures to handle different modes being represented by different fixtures?)
  5. Finish definitions fixture by fixture: Show the fixture editor, prefilled with the imported data (similar to editing existing fixtures #564) and the fixture-valid result in the beginning.
  6. Submit all fixtures as pull request (like adding a new fixture, but now just several ones).

Like editing existing fixtures, we have to deal with fixture features that aren't supported by the editor yet (see #311). Maybe we simply wait until the editor supports all features, or the fixtures with unsupported features are grayed out in 4. and need manual editing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests. Start by tracing the existing CLI import method and the public fixture editor, then compare them with the workflows described here; done means users can select a plugin, upload one or more files, review and edit imported fixtures, and submit the resulting definitions as a pull request.

Written by the indexing model from the issue text.

Assessment

Tech stack
nodejs, nuxt
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.