Autodesk / Autodesk/shore

Better UX for Project Name changing

Open
#46 0 comments 0 reactions 0 assignees View on GitHub
DevX init
Dominant language
Go
Stars
21
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Original Author: @dkirillov

This is follow up for issue #108 .

When doing `shore project init` and giving the project name, the output that contains the project's name might be mutated - for instance stripped of various characters.

Especially in the case of a Spinnaker backend, the application and pipeline names both mutate the project name in different ways.

While we know this is to compile with how Spinnaker likes its' application and pipeline names - to someone that's unfamiliar, this may seem odd/confusing (why has project name been mutated, and it happened differently twice).

We should provide some sort of output saying "Hey we will mutate the project's name to compile with the backend", maybe provide how they will be mutated, or even the regex for mutation. This way it will not be a surprise to give a project name and then see it mutated in the output.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the `shore project init` entry point and trace where the project, application, and pipeline names are displayed. Inspect the Spinnaker backend's name-mutation behavior, then define the user-facing explanation and verify that the output makes each resulting name understandable.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.