OpenLightingProject / OpenLightingProject/open-fixture-library

More information for manufacturers

Open
#299 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

  • Store a fullname that should be the same as the one for which its RDM ID is registered for at ESTA.

  • Think of a way to store child brands for a manufacturer, possibly:

    {
      // …
      "music-and-lights-srl": {
        "name": "Music & Lights",
        "fullName": "Music & Lights S.r.l.",
        "rdmId": 5584
      },
      // …
      "prolights": {
        "name": "Prolights",
        "childBrandOf": "music-and-lights-srl"
        // no rdmId set here, but could overwrite it
      },
      "prolights-tribe": {
        "name": "Prolights Tribe",
        "childBrandOf": "music-and-lights-srl"
      },
      // …
    }
    

    Then, the fixtures-valid test only has to make sure that childBrandOf refers to a valid manufacturer.

see also https://github.com/FloEdelmann/open-fixture-library/issues/288#issuecomment-336628826 and https://github.com/FloEdelmann/open-fixture-library/pull/298#pullrequestreview-69390128

cc @peternewman

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

Start by reading the discussion in issue 288 and the review on pull request 298, then inspect the manufacturer data and the fixtures-valid test. Determine how fullname and childBrandOf should be represented and validated. Done means manufacturer records can store the registered full name and child brands, with validation rejecting invalid parent references.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
data, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.