jerdra/niviz-rater

ENH: Exemplar ratings for categories

Open

#11 opened on Dec 8, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (4 forks)auto 404
backendenhancementfrontendhelp wantedimpact: medium

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

There's been user feedback for the implementation of exemplar QC items for each qc category. The purpose of this is to serve as an example of the typical characteristics a certain QC image should have in order to be rated for a given category.

The requirements we hope to meet in this issue are the following:

Back-end

  1. Add a database boolean column for is_exemplar in models.py
  2. Include this as part of initial data pull from the initial data fetch

Front-end

  1. Include an "Mark as Exemplar" in the QC modal interface
  2. When an item is an "Exemplar" it should have a visual cue to indicate that it is a defining feature (add a UI element over a tile marked as an exemplar).
  3. When sorted by QC category, items marked as an Exemplar should always appear first

Contributor guide

Research direction
Explore the repository structure to locate the database models and front end components. Understand how QC categories are currently implemented and how the rating modal works. Identify the initial data fetch logic. From there, plan the addition of the exemplar boolean field, ensure it is included in the fetched data, and design UI changes for marking and displaying exemplar items.
Tech stack
python
Domain
full stackweb dev
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65