kyma-project / kyma-project/cli

CLI: modules package refactor PoC

Open
#2,786 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
125
Forks
124
PR merge metrics
No merged PRs in 30d

Description

Problem

  • During the QA phase there were multiple bugs, improvement ideas, inconsistencies found.
  • We've noticed that some things require changes of similar things in multiple places in order to work consistently. That suggest there's a room for architectural improvement.
  • Over the course of months the requirements for community modules were changing and now we're at point where we already have a good idea how we want things to work. The modules package grew big enough that there's a solid reason to think about incorporating more mature architectural solutions.

Expected output:

  • The first command that's going to be refactored is kyma module catalog
  • The idea is to do research on approaches that could be used in order to structure the code more efficiently, in a way that would allow for a better scalability, readability and maintainability.
  • From the user perspective, the kyma module catalog command should work similarly as the previous version.
  • The command should be available under the kyma alpha module catalog command - both versions are still available to the user.
  • Prepare the ADR document that will describe solutions used in the refactored code.

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

Locate the implementation of the kyma module catalog command and run it to establish its current behavior. Research architectural approaches for restructuring the modules package while preserving that behavior, expose the refactored command under kyma alpha module catalog, and document the chosen solution in an ADR.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.