AbsaOSS/enceladus

Conformance Rules - Tooltips

Open

#308 opened on Apr 9, 2019

View on GitHubContributor guide
 (5 comments) (2 reactions) (0 assignees)Scala (16 forks)auto 404
MenasUXfeaturegood first issuepriority: low

Repository metrics

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

Description

Background

Conformance Rules can be difficult to understand.

Feature

We can add tooltips to the rules which provide a concise explanation.

Proposed Solution [Optional]

Conformance Rules ToolTips
CastingConformanceRule Conversion of one input data type to another output data type.
ConcatenationConformanceRule Combine data contents from two or more input columns together in one output column.
DropConformanceRule Drop (or remove) a column from the input dataset so that it doesn't appear in the output.
LiteralConformanceRule Place a literal value in a specified output column.
MappingConformanceRule Lookup and join values from input and output columns to target columns.
NegationConformanceRule Convert numeric values from positive to negative, and vice versa.
SingleColumnConformanceRule Place a value from an input column in a struct, where the output column contains the name of the input field as an alias.
SparkSessionConformanceRule Extract values from the spark session conf_info file for use in the dataset (e.g. version).
UppercaseConformanceRule Transform input text values to uppercase.

Contributor guide

Research direction
Identify where each conformance rule's tooltip can be added (likely in the UI or rule definition) and provide a concise explanation for each rule as proposed in the issue.
Tech stack
scala
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Scala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80