saveourtool/save-cloud

Refactor `Companion.NAME` and `name` in `Sdk`

Open

#859 opened on Jun 28, 2022

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Kotlin (4 forks)github user discovery
good first issuerefactoring

Repository metrics

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

Description

There are string values for two purposes: display name, which is currently Companion.NAME, and docker image name, which is in the property name. This is indeed confusing.

Originally posted by @petertrr in https://github.com/saveourtool/save-cloud/pull/840#discussion_r908378107

Contributor guide

Research direction
Identify all usages of Companion.NAME and name property in Sdk class, separate them into distinct fields for display name and docker image name, and update references accordingly.
Tech stack
kotlin
Domain
backendclouddevops
Issue type
Refactor
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.
Half day
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
Kotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60